Skip to main content

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 code
  • tests/: Unit and integration tests
  • docs/: 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

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Commit your changes. Commits should follow conventional commits. The repo is configured with commitizen
  4. Push to your fork and open a pull request

Please include tests for new features and bug fixes.

License

See LICENSE.md

Metadata

Release files for ynab-cli 0.8.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ynab-cli 0.8.3
File Size Uploaded Provenance Actions
ynab_cli-0.8.3.tar.gz 280.1 kB With provenance Details for ynab_cli-0.8.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ynab-cli 0.8.3
File Interpreter ABI Platform Actions
ynab_cli-0.8.3-py3-none-any.whl Python 3 none any Details for ynab_cli-0.8.3-py3-none-any.whl

Total release size: 550.5 kB

Release files / ynab_cli-0.8.3.tar.gz

Download URL ynab_cli-0.8.3.tar.gz
Size 280.1 kB
Tags Source
SHA-256 checksum
How to use checksums
ca8c64d005ea60be31a79e0efa125b9068e81d6bbe3e8428d600940b0ac155ef
BLAKE2b-256 checksum
How to use checksums
2f804b80e72aa268964edf52055848891b51ad543b906dd0076df40c422cea59
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Oct 27, 2026.

Transparency log

Release files / ynab_cli-0.8.3-py3-none-any.whl

Download URL ynab_cli-0.8.3-py3-none-any.whl
Size 270.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dd29cdd5cdaefca7201f61352250c3f9f1ab18cd5ad1647698286e95479ae811
BLAKE2b-256 checksum
How to use checksums
c427fe9fc0251bbe43799d38dacb0dcb202106d1ad2b21d00825c4ef4365330c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Oct 27, 2026.

Transparency log

Security for ynab-cli 0.8.3

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ynab_cli-0.8.3.tar.gz

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 Oct 27, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page