codapact-ynab 0.2.0__tar.gz

codapact_ynab-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mike Hill
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codapact_ynab-0.2.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: codapact-ynab
+Version: 0.2.0
+Summary: Typed Python client and `ynab` CLI for the YNAB API, generated by Codapact
+Keywords: ynab,budget,cli,api-client,codapact
+Author: Mike Hill
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Dist: codapact[keyring]>=0.8.0,<0.9
+Requires-Python: >=3.13
+Project-URL: Homepage, https://github.com/mikejhill/codapact-ynab
+Project-URL: Repository, https://github.com/mikejhill/codapact-ynab
+Project-URL: Issues, https://github.com/mikejhill/codapact-ynab/issues
+Project-URL: Generator, https://github.com/mikejhill/codapact
+Description-Content-Type: text/markdown
+
+# codapact-ynab
+
+The **YNAB coda**: a typed Python client and `ynab` command-line tool for the
+[YNAB API](https://api.ynab.com/), generated from YNAB's OpenAPI contract by
+[Codapact](https://github.com/mikejhill/codapact).
+
+Replaces `ynab-api-cli`, which is no longer maintained.
+
+## Install
+
+```console
+uv tool install codapact-ynab     # or: pipx install codapact-ynab
+ynab --help
+```
+
+Requires Python 3.13+.
+
+## Credentials
+
+Create a personal access token under YNAB **Account Settings → Developer Settings**, then either:
+
+```console
+ynab auth login        # saves it in the OS keyring
+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
+
+```console
+ynab plans list
+ynab accounts list -o table
+ynab transactions list --since-date 2026-01-01 --query 'data.transactions[].payee_name'
+ynab describe --brief  # 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`).
+
+As a library:
+
+```python
+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 |
+
+```console
+uvx codapact==0.8.0 sync --check   # has YNAB published a new contract?
+uvx codapact==0.8.0 sync           # pull it into openapi.yaml
+uvx codapact==0.8.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.

codapact_ynab-0.2.0/README.md

@@ -0,0 +1,67 @@
+# codapact-ynab
+
+The **YNAB coda**: a typed Python client and `ynab` command-line tool for the
+[YNAB API](https://api.ynab.com/), generated from YNAB's OpenAPI contract by
+[Codapact](https://github.com/mikejhill/codapact).
+
+Replaces `ynab-api-cli`, which is no longer maintained.
+
+## Install
+
+```console
+uv tool install codapact-ynab     # or: pipx install codapact-ynab
+ynab --help
+```
+
+Requires Python 3.13+.
+
+## Credentials
+
+Create a personal access token under YNAB **Account Settings → Developer Settings**, then either:
+
+```console
+ynab auth login        # saves it in the OS keyring
+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
+
+```console
+ynab plans list
+ynab accounts list -o table
+ynab transactions list --since-date 2026-01-01 --query 'data.transactions[].payee_name'
+ynab describe --brief  # 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`).
+
+As a library:
+
+```python
+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 |
+
+```console
+uvx codapact==0.8.0 sync --check   # has YNAB published a new contract?
+uvx codapact==0.8.0 sync           # pull it into openapi.yaml
+uvx codapact==0.8.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.

codapact_ynab-0.2.0/codapact.yaml

@@ -0,0 +1,13 @@
+version: 1
+source:
+  type: openapi
+  path: openapi.yaml
+  upstream: https://api.ynab.com/papi/open_api_spec.yaml   # codapact sync / sync --check
+shape:
+  - group: {by: tag}
+  - defaults:
+      params: {"*.plan_id": last-used}
+cli: {program: ynab}
+targets:
+  - {name: python, output: gen/python, options: {package: codapact_ynab, distribution: codapact-ynab}}
+  - {name: python-cli, output: gen/python}

codapact_ynab-0.2.0/gen/python/src/codapact_ynab/__init__.py

@@ -0,0 +1,6 @@
+"""Generated client for YNAB API Endpoints."""
+
+from .types import *  # noqa: F403
+from .client import Client
+
+__all__ = ["Client"]

codapact_ynab-0.2.0/gen/python/src/codapact_ynab/__main__.py

@@ -0,0 +1,6 @@
+"""Run the generated CLI with ``python -m``."""
+
+from .cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())