Jake/data_pipeline_for_YNAB
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ready for open source

Browse Source
This commit is contained in:
Jake Pullen
2024-08-10 09:50:37 +01:00
parent c9b01e85d5
commit b29b738a7a
6 changed files with 81 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ReadMe.md
+8 -12
View File
@@ -1,22 +1,18 @@
# Budget Management System
This project is a Budget Management System that fetches and caches budget-related data from an API. It organizes the data into various categories and handles rate limits to ensure smooth operation.
This project is a Budget Management System that fetches and caches budget-related data from an API. It organizes the data into a dimensional model and handles rate limits to ensure smooth operation.
## Project Structure
## Setup
1. **Set up environment variables:**
Create a `.env` file in the root directory and add your API token and budget ID:
```
API_TOKEN=your_api_token
BUDGET_ID=your_budget_id
```
## [Get Started Guide](docs/Get_Started.md)
## Usage
This tool has been desined to be used to fetch and cache budget-related data from the YNAB API. It can be used multiple times a day or once a year or anything in between. It is designed to be flexible and easy to use.
Once it is on your local machine, you can run it by executing the `main.py` file. This will handle situations where you have not run the tool before, or where you have run it before and need to update the data. It will not duplicate any data caused by running it multiple times.
## Contributing
Not expecting any contributions at this time.
## License
[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)