levibostian / ynab-scheduled-ical

Generate iCal calendar that contains your scheduled YNAB transactions

ynab-scheduled-ical

More easily see your upcoming YNAB scheduled transactions.

This project generates a calendar you can subscribe to using the calendar app you're already using that displays all of the scheduled transactions in your YNAB budget.

Why did you create this?

I create my month's YNAB budget at the beginning of each month. One step in creating my budget is to view upcoming events in my calendar to see if I planned for those events in my budget. Then, I check my scheduled transactions for the month in YNAB to see if there are any I should delete or modify.

Because I am swapping between my YNAB budget and my calendar app, I figured being able to see both at once would make the task easier.

Getting started

Want to use this project yourself? Follow these steps.

• Fork this repo.
• In the repository settings, set these GitHub Action Secrets:

1. YNAB_PERSONAL_ACCESS_TOKEN - Generate a new YNAB personal access token. Follow the YNAB API docs Quick Start section for the most up-to-date method on how to generate this token.
2. YNAB_BUDGET_NAME - The name of your budget in YNAB.
3. GIST_PERSONAL_ACCESS_TOKEN - A GitHub personal access token with the permissions gist enabled.

• Run the GitHub Action workflow manually to have the calendar created.
• Open the newly created Gist and get the Gist ID. Put that ID into this URL:

https://gist.githubusercontent.com/<your-github-username>/<gist-id>/raw/ynab_scheduled.ics

• Open your calendar app and subscribe to this ical URL.

Tip: Keep this URL a secret. Unless you want others to view your upcoming transactions, don't share the URL. If you do share the URL by accident, just delete the Gist and the next time this project runs, a new Gist will be created.

Contribute

Want to contribute to this project?

Dev setup

• Install Deno.
• Run the deno run script that's located in ./.github/workflows/update-gist-ical.yml. It's recommended to run with --debug at the end of the command during local development.

ynab-scheduled-ical's Issues

Fix update dependencies workflow

Setup GitHub Action cron workflow to run script that generates ical file

Paging of YNAB scheduled transactions

Create/update GitHub Gist that hosts the ical file for your calendar to subscribe to

Feature: Create link in the calendar invite which navigates to the transaction in YNAB (browser or app)

Research

• First, go into ynab website, view a transaction, and see if the URL changes to view it? If so, we can compose a URL that goes to a specific transaction. Otherwise, maybe this feature will not work?

• Then, we can manually add a URL to a calendar event and click on it on Android calendar. See if YNAB Android app launches for us.

Setup CI to autoupdate Deno dependencies

This project seems promising. Set it up with a re-usable CI action workflow so I can re-use on all my projects.

README

• problem it solves
• contributing, dev setup, how to debug
• design
  • log, but no private information
  • anyone can use by forking and setting up

Create script that generates ical file

• Gets all future YNAB transactions for all accounts.
• From list of transactions, create an ical calendar that has all of the transactions added to it's day the transaction will be made. Make each event an "all day" event. Use method .save() to save it to a file.
• Let's test this file. Can I add it to my local mac calendar and make sure it's accurate?

put memo into title. no more needing to go into the description.