ynab-cli 0.3.0__tar.gz → 0.4.0__tar.gz

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/CHANGELOG.md

@@ -16,6 +16,12 @@
 
 - cleaned up some code, sorted lists, and improved the file selector
 
+## v0.4.0 (2025-06-06)
+
+### Feat
+
+- **budgets**: added a command to list all budgets
+
 ## v0.3.0 (2025-06-06)
 
 ### BREAKING CHANGE

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ynab-cli
-Version: 0.3.0
+Version: 0.4.0
 Summary: YNAB Command Line Interface
 Author: Jeff Sawatzky
 License-File: LICENSE.md

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/docs/index.md

@@ -4,33 +4,34 @@ This is a simple cli/tui application written in python to help manage your YNAB
 
 ## Requirements
 
-- Python 3.11+
-- [uv](https://docs.astral.sh/uv/)
-- Your [YNAB developer access token](https://api.ynab.com/#personal-access-tokens)
-- Your YNAB budget ID. You can get this from your browser URL while you have your budget open. For example, if the URL looks like `https://app.ynab.com/aaaaaaaa-1111-bbbb-2222-ddddddd` then the budget ID is `aaaaaaaa-1111-bbbb-2222-ddddddd`.
+- [uv](https://docs.astral.sh/uv/getting-started/installation/) which allows you to easily run python applications.
+- Your [YNAB developer access token](https://api.ynab.com/#personal-access-tokens).
 
-## Installation
+!!! warning
+    Developer access tokens are rate limited to 200 requests per hour. Some of the commands below will provide you an opportunity to enter a new developer access token when the current one has exceeded it's limit. It also seems like there is a limit to how many developer access tokens you can create from the developer settings UI.
+
+- Your YNAB budget ID. Once you have `uv` and your `access token` you can list your budgets by running:
 ```sh
-$ git clone https://github.com/jeffsawatzky/ynab-cli.git
-$ cd ynab-cli
-$ uv sync
+$ uvx ynab-cli run --access-token your_access_token budgets list-all
 ```
 
 ## Usage
 
-!!! warning
-    Developer access tokens are rate limited to 200 requests per hour. Some of the commands below will provide you an opportunity to enter a new developer access token when the current one has exceeded it's limit. It also seems like there is a limit to how many developer access tokens you can create from the developer settings UI.
-
 !!! note
-    YNAB CLI supports environment variables and dotenv (`.env`) files for specifying options. See the `.env-sample` file for some examples. It looks for the `.env` file in current working directory.
+    YNAB CLI supports environment variables and dotenv (`.env`) files for specifying options. See the `.env-sample` file for some examples. YNAB CLI looks for the `.env` file in current working directory. If you create a `.env` file with the following information you won't need to keep entering it on the command line.
+
+    ``` title=".env"
+    YNAB_CLI_ACCESS_TOKEN=your_access_token
+    YNAB_CLI_BUDGET_ID=your_budget_id
+    ```
 
 To run the text ui, execute the following command:
 
 ```sh
-$ uv run ynab-cli
+$ uvx ynab-cli
 ```
 
-Full command line usage is below.
+The individual CLI commands can be similarily run using `uvx`. Full command line usage is below.
 
 ::: mkdocs-click
     :module: ynab_cli.host.cli

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ynab-cli"
-version = "0.3.0"
+version = "0.4.0"
 description = "YNAB Command Line Interface"
 readme = "README.md"
 authors = [

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/src/ynab_cli/adapters/ynab/models/budget_summary_response_data.py

@@ -61,7 +61,7 @@ class BudgetSummaryResponseData:
 
         _default_budget = d.pop("default_budget", UNSET)
         default_budget: Unset | BudgetSummary
-        if isinstance(_default_budget, Unset):
+        if not _default_budget or isinstance(_default_budget, Unset):
             default_budget = UNSET
         else:
             default_budget = BudgetSummary.from_dict(_default_budget)

ynab_cli-0.4.0/src/ynab_cli/domain/use_cases/budgets.py

@@ -0,0 +1,33 @@
+from collections.abc import AsyncIterator
+from typing import TypedDict
+
+from ynab_cli.adapters import ynab
+from ynab_cli.adapters.ynab import models, util
+from ynab_cli.adapters.ynab.api.budgets import get_budgets
+from ynab_cli.domain import ports
+from ynab_cli.domain.constants import YNAB_API_URL
+from ynab_cli.domain.settings import Settings
+
+
+class ListAllParams(TypedDict):
+    pass
+
+
+async def list_all(settings: Settings, io: ports.IO, params: ListAllParams) -> AsyncIterator[models.BudgetSummary]:
+    async with ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token) as client:
+        try:
+            budgets = (
+                await util.get_asyncio_detailed(io, get_budgets.asyncio_detailed, include_accounts=True, client=client)
+            ).data.budgets
+            budgets.sort(key=lambda b: b.name)
+
+            progress_total = len(budgets)
+            for budget in budgets:
+                await io.progress.update(total=progress_total, advance=1)
+                yield budget
+
+        except util.ApiError as e:
+            if e.status_code == 429:
+                await io.print("API rate limit exceeded. Try again later, or get a new access token.")
+            else:
+                await io.print(f"Exception when calling YNAB: {e}\n")

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/src/ynab_cli/host/click/cli.py

@@ -3,8 +3,8 @@ import logging
 import click
 from rich.logging import RichHandler
 
-from ynab_cli.domain.settings import Settings, YnabSettings
-from ynab_cli.host.click.commands import categories, payees, transactions
+from ynab_cli.domain.settings import Settings
+from ynab_cli.host.click.commands import budgets, categories, payees, transactions
 from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS, ENV_PREFIX
 
 
@@ -17,18 +17,16 @@ from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS, ENV_PREFIX
     show_envvar=True,
     help="YNAB API access token.",
 )
-@click.option("--budget-id", prompt=True, envvar=f"{ENV_PREFIX}_BUDGET_ID", show_envvar=True, help="YNAB budget ID.")
 @click.pass_context
 def run(
     ctx: click.Context,
     access_token: str,
-    budget_id: str,
 ) -> None:
     """Main entrypoint for YNAB CLI commands."""
 
     ctx.ensure_object(dict)
     settings: Settings = ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())
-    settings.ynab = YnabSettings(access_token=access_token, budget_id=budget_id)
+    settings.ynab.access_token = access_token
     ctx.obj[CONTEXT_KEY_SETTINGS] = settings
 
     logging.basicConfig(
@@ -39,6 +37,7 @@ def run(
     )
 
 
-run.add_command(payees.payees)
+run.add_command(budgets.budgets)
 run.add_command(categories.categories)
+run.add_command(payees.payees)
 run.add_command(transactions.transactions)

ynab_cli-0.4.0/src/ynab_cli/host/click/commands/budgets.py

@@ -0,0 +1,54 @@
+import asyncio
+
+import click
+from rich.table import Table
+
+from ynab_cli.adapters.rich import io
+from ynab_cli.domain.settings import Settings
+from ynab_cli.domain.use_cases import budgets as use_cases
+from ynab_cli.host.click.commands.rich.progress_table import ProgressTable
+from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS
+
+
+async def _list_all(settings: Settings) -> None:
+    params: use_cases.ListAllParams = {}
+
+    table = Table(title="All Budgets")
+    table.add_column("Budget ID")
+    table.add_column("Budget Name")
+
+    console = None
+    with ProgressTable(table) as progress:
+        console = progress.console
+
+        task_id = progress.add_task("Loading all budgets...")
+        async for budget in use_cases.list_all(settings, io.RichIO((progress, task_id)), params):
+            table.add_row(
+                str(budget.id),
+                str(budget.name),
+            )
+
+    if console:
+        console.print(table)
+
+
+@click.command()
+@click.pass_context
+def list_all(ctx: click.Context) -> None:
+    """List all budgets in YNAB."""
+
+    ctx.ensure_object(dict)
+    asyncio.run(_list_all(ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())))
+
+
+@click.group()
+@click.pass_context
+def budgets(ctx: click.Context) -> None:
+    """Manage YNAB budgets in YNAB."""
+
+    ctx.ensure_object(dict)
+    settings: Settings = ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())
+    ctx.obj[CONTEXT_KEY_SETTINGS] = settings
+
+
+budgets.add_command(list_all)

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/src/ynab_cli/host/click/commands/categories.py

@@ -7,7 +7,7 @@ from ynab_cli.adapters.rich import io
 from ynab_cli.domain.settings import Settings
 from ynab_cli.domain.use_cases import categories as use_cases
 from ynab_cli.host.click.commands.rich.progress_table import ProgressTable
-from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS
+from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS, ENV_PREFIX
 
 
 async def _list_unused(settings: Settings) -> None:
@@ -81,12 +81,16 @@ def list_all(ctx: click.Context) -> None:
 
 
 @click.group()
+@click.option("--budget-id", prompt=True, envvar=f"{ENV_PREFIX}_BUDGET_ID", show_envvar=True, help="YNAB budget ID.")
 @click.pass_context
-def categories(ctx: click.Context) -> None:
+def categories(ctx: click.Context, budget_id: str) -> None:
     """Manage YNAB categories in the YNAB budget."""
 
     ctx.ensure_object(dict)
+    settings: Settings = ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())
+    settings.ynab.budget_id = budget_id
+    ctx.obj[CONTEXT_KEY_SETTINGS] = settings
 
 
-categories.add_command(list_unused)
 categories.add_command(list_all)
+categories.add_command(list_unused)

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/src/ynab_cli/host/click/commands/payees.py

@@ -7,7 +7,7 @@ from ynab_cli.adapters.rich import io
 from ynab_cli.domain.settings import Settings
 from ynab_cli.domain.use_cases import payees as use_cases
 from ynab_cli.host.click.commands.rich.progress_table import ProgressTable
-from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS
+from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS, ENV_PREFIX
 
 
 async def _normalize_names(settings: Settings) -> None:
@@ -144,14 +144,18 @@ def list_all(ctx: click.Context) -> None:
 
 
 @click.group()
+@click.option("--budget-id", prompt=True, envvar=f"{ENV_PREFIX}_BUDGET_ID", show_envvar=True, help="YNAB budget ID.")
 @click.pass_context
-def payees(ctx: click.Context) -> None:
+def payees(ctx: click.Context, budget_id: str) -> None:
     """Manage payees in the YNAB budget."""
 
     ctx.ensure_object(dict)
+    settings: Settings = ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())
+    settings.ynab.budget_id = budget_id
+    ctx.obj[CONTEXT_KEY_SETTINGS] = settings
 
 
-payees.add_command(normalize_names)
+payees.add_command(list_all)
 payees.add_command(list_duplicates)
 payees.add_command(list_unused)
-payees.add_command(list_all)
+payees.add_command(normalize_names)

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/src/ynab_cli/host/click/commands/transactions.py

@@ -10,7 +10,7 @@ from ynab_cli.domain.models import rules
 from ynab_cli.domain.settings import Settings
 from ynab_cli.domain.use_cases import transactions as use_cases
 from ynab_cli.host.click.commands.rich.progress_table import ProgressTable
-from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS
+from ynab_cli.host.constants import CONTEXT_KEY_SETTINGS, ENV_PREFIX
 
 
 async def _apply_rules(settings: Settings, transaction_rules: rules.TransactionRules) -> None:
@@ -66,11 +66,15 @@ def apply_rules(ctx: click.Context, rules_file: IO[Any]) -> None:
 
 
 @click.group()
+@click.option("--budget-id", prompt=True, envvar=f"{ENV_PREFIX}_BUDGET_ID", show_envvar=True, help="YNAB budget ID.")
 @click.pass_context
-def transactions(ctx: click.Context) -> None:
+def transactions(ctx: click.Context, budget_id: str) -> None:
     """Manage transactions in the YNAB budget."""
 
     ctx.ensure_object(dict)
+    settings: Settings = ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())
+    settings.ynab.budget_id = budget_id
+    ctx.obj[CONTEXT_KEY_SETTINGS] = settings
 
 
 transactions.add_command(apply_rules)

{ynab_cli-0.3.0 → ynab_cli-0.4.0}/uv.lock

@@ -1503,7 +1503,7 @@ wheels = [
 
 [[package]]
 name = "ynab-cli"
-version = "0.3.0"
+version = "0.4.0"
 source = { editable = "." }
 dependencies = [
     { name = "attrs" },