Micro YNAB

Micro YNAB is a small SDK for the YNAB budgeting app. It provides a simple interface to interact with the YNAB API, allowing you to manage budgets, categories, transactions, and more.

Features

• Manage budgets and budget settings
• Handle categories and category groups
• Work with payees and transactions
• Simple and easy-to-use interface

Installation

To install the package, use pip:

pip install uynab

Usage

Code

Here's a basic example of how to use the SDK:

from uynab.client import YNABClient

client = YNABClient(api_token="YOUR_YNAB_API_TOKEN")

# Get all budgets
budgets = client.budget.get_all_budgets()
print(budgets)

Standalone

python -m uynab budget list

Storing API Token

You can store YNAB API token in an environmental variable: YNAB_API_TOKEN.

For example:

export YNAB_API_TOKEN='<your token>'

For security reasons you can also store API token in a .env file. The application auto-loads the .env file from the root directory if it exists. Format is the same: YNAB_API_TOKEN='<your token>'.

Note: Environment variables defined in your system will override the entries from the .env file.

Documentation

For detailed documentation, visit the docs.

Contributing

Contributions are welcome! Please see the contribution guidelines for more information.

License

This project is licensed under the MIT License. See the LICENSE file for details.