YNAB CLI
A command-line interface for interacting with YNAB (You Need A Budget).
Usage
Full user documentation available here
Project Structure
src/ynab_cli/: Main source codetests/: Unit and integration testsdocs/: Documentation (built with MkDocs)
Getting Started
Prerequisites
- Python 3.11+
- uv
Installation
Clone the repository:
$ git clone https://github.com/jeffsawatzky/ynab-cli.git
$ cd ynab-cli
Install dependencies with uv:
$ uv sync
Running the CLI
With uv:
$ uv run ynab-cli --help
Development
- Source code is in
src/ynab_cli/. - Use feature branches for new work.
- Follow PEP8 and use type hints where possible.
Linting & Formatting
$ make lint
Running Tests
$ make test
Or directly with pytest:
uv run pytest
Documentation
- Docs are in
docs/and built with MkDocs. - To serve docs locally:
$ uv run mkdocs serve
Contributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/your-feature) - Commit your changes. Commits should follow conventional commits. The repo is configured with commitizen
- Push to your fork and open a pull request
Please include tests for new features and bug fixes.
License
See LICENSE.md
1 maintainer
Metadata
1 maintainer
Release files for ynab-cli 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ynab_cli-0.8.0.tar.gz | 268.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ynab_cli-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 538.4 kB
Release files / ynab_cli-0.8.0.tar.gz
| Download URL | ynab_cli-0.8.0.tar.gz |
|---|---|
| Size | 268.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
efa6f797fd4f33663d67f0d07af98e7840d9443c065344108e215164cbd78109
|
|
BLAKE2b-256 checksum How to use checksums |
b956b68a5cf11816ce057b3527060529daffbc965ec32ea1e1c425d9f3d063de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logRelease files / ynab_cli-0.8.0-py3-none-any.whl
| Download URL | ynab_cli-0.8.0-py3-none-any.whl |
|---|---|
| Size | 270.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
877833986b5064aad10dcc482e474c552399552105e56011d90181b54db80d67
|
|
BLAKE2b-256 checksum How to use checksums |
df69bbd5131b94b3bc4d64f1a766aaf6616ed65781c7de5575aeaa7723b33216
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency log
