Skip to main content

codapact-ynab

The YNAB coda: a typed Python client and codapact-ynab command-line tool for the YNAB API, generated from YNAB's OpenAPI contract by Codapact.

Replaces ynab-api-cli, which is no longer maintained.

Install

uvx codapact-ynab --help          # run without installing
uv tool install codapact-ynab     # or install it: pipx install codapact-ynab
codapact-ynab --help

Requires Python 3.13+.

Credentials

Create a personal access token under YNAB Account Settings → Developer Settings, then either:

codapact-ynab auth login   # saves it in the OS keyring
codapact-ynab doctor       # checks settings, credentials, and connectivity

or set YNAB_BEARER in the environment. YNAB_BEARER_COMMAND runs a command that prints the token (for example a password manager).

Use

codapact-ynab plans list
codapact-ynab accounts list -o table
codapact-ynab transactions list --since-date 2026-01-01 --query 'data.transactions[].payee_name'
codapact-ynab describe --brief   # how to start, auth, and every command (for scripts and agents)

--plan-id defaults to last-used. --dry-run prints the HTTP request without sending it; commands that delete ask for confirmation (or --yes).

Upgrading from 0.2.0, where the command was ynab: a login saved with ynab auth login and settings in ~/.config/ynab/ are picked up automatically.

As a library:

from codapact_ynab import Client

client = Client()

How this repository works

Path What it is
openapi.yaml YNAB's contract, pinned (currently API 1.91.0)
codapact.yaml Codapact project file: shaping rules and targets
gen/python/ Generated code and tests. Do not edit; regenerate
pyproject.toml Hand-written packaging: PyPI metadata and the release version
uvx codapact==0.9.0 sync --check   # has YNAB published a new contract?
uvx codapact==0.9.0 sync           # pull it into openapi.yaml
uvx codapact==0.9.0 generate       # regenerate gen/python
uv run pytest                      # offline tests

CI fails if gen/python differs from what the pinned Codapact produces. Releases are cut by release-please and published to PyPI through trusted publishing.

Metadata

Release files for codapact-ynab 0.3.0

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

Source distribution (sdist)

Source distribution for codapact-ynab 0.3.0
File Size Uploaded Provenance Actions
codapact_ynab-0.3.0.tar.gz 55.1 kB With provenance Details for codapact_ynab-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for codapact-ynab 0.3.0
File Interpreter ABI Platform Actions
codapact_ynab-0.3.0-py3-none-any.whl Python 3 none any Details for codapact_ynab-0.3.0-py3-none-any.whl

Total release size: 95.7 kB

Release files / codapact_ynab-0.3.0.tar.gz

Download URL codapact_ynab-0.3.0.tar.gz
Size 55.1 kB
Tags Source
SHA-256 checksum
How to use checksums
716cf5504f7b7dcc5f476e2bebc0b7c6e3539bb8916059ed9d44334ac70cd584
BLAKE2b-256 checksum
How to use checksums
1954a9951b6c738942500befcb7d2c573583db487ad14e5344677605be9339fc
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 Nov 15, 2026.

Transparency log

Release files / codapact_ynab-0.3.0-py3-none-any.whl

Download URL codapact_ynab-0.3.0-py3-none-any.whl
Size 40.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f5b65450a23607ba5eb140a9d66abfae7827e560eea8b698d3569f4ecf252b40
BLAKE2b-256 checksum
How to use checksums
e7d335dc47e3b7201bfacd2a395656a113383fc59820c645bbcec5cfbec6b1da
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 Nov 15, 2026.

Transparency log

Security for codapact-ynab 0.3.0

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 codapact_ynab-0.3.0.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 Nov 15, 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.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files Full provenance

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