Skip to main content

Micro YNAB - a small SDK for YNAB budgeting app

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uynab-0.1.4.tar.gz (68.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uynab-0.1.4-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file uynab-0.1.4.tar.gz.

File metadata

  • Download URL: uynab-0.1.4.tar.gz
  • Upload date:
  • Size: 68.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for uynab-0.1.4.tar.gz
Algorithm Hash digest
SHA256 663b4256241a3eb1021ca7f6cbf93e2f5e2d4630aa90d4b66631c575887512df
MD5 037c9bb052dadc3eb357f5ccfbaf37f9
BLAKE2b-256 a8284ab074c3b2f125c72b94fb72bbc112a28291c32036df6819f55cd4ac5435

See more details on using hashes here.

Provenance

The following attestation bundles were made for uynab-0.1.4.tar.gz:

Publisher: release.yml on ajwalkiewicz/uynab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file uynab-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: uynab-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for uynab-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b4d7539366a31a47830e78fd8a6a263aadcdce38080d6a14f339f295ed72e84a
MD5 0f5347661d1b42b0d00e49aa2f2ab01c
BLAKE2b-256 68e2a84876b1dbc996d6c9f12c3182bc70b13d96ac4847fb3f6c406142eefecb

See more details on using hashes here.

Provenance

The following attestation bundles were made for uynab-0.1.4-py3-none-any.whl:

Publisher: release.yml on ajwalkiewicz/uynab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page