ynab-cli 0.5.2__tar.gz → 0.5.4__tar.gz

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.5.4 (2025-06-10)
+
+### Fix
+
+- **tui**: added some command parameter forms
+
+## v0.5.3 (2025-06-09)
+
+### Fix
+
+- **tui**: moves the app settings into a separate modal dialog
+
 ## v0.5.2 (2025-06-07)
 
 ### Fix

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ynab-cli
-Version: 0.5.2
+Version: 0.5.4
 Summary: YNAB Command Line Interface
 Project-URL: Changelog, https://github.com/jeffsawatzky/ynab-cli/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://jeffsawatzky.github.io/ynab-cli/

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ynab-cli"
-version = "0.5.2"
+version = "0.5.4"
 description = "YNAB Command Line Interface"
 readme = "README.md"
 requires-python = ">=3.11"

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/src/ynab_cli/adapters/textual/io.py

@@ -1,13 +1,11 @@
 from typing import Any
 
-from textual import on
 from textual.app import App, ComposeResult
-from textual.containers import Vertical
-from textual.screen import ModalScreen
 from textual.widgets import Input, Label, Log, ProgressBar
 from typing_extensions import override
 
 from ynab_cli.domain.ports.io import IO, Progress
+from ynab_cli.host.textual.widgets.common.dialogs import CANCELLED, DialogForm, SaveCancelDialogScreen
 
 
 class TextualProgress(Progress):
@@ -28,9 +26,7 @@ class TextualProgress(Progress):
         self._progress_bar.update(**kwargs)
 
 
-class IOScreen(ModalScreen[str]):
-    """A simple modal screen which asks for user input."""
-
+class IODialogForm(DialogForm[str]):
     def __init__(self, prompt: str, password: bool, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
         self._prompt = prompt
@@ -38,16 +34,15 @@ class IOScreen(ModalScreen[str]):
 
     @override
     def compose(self) -> ComposeResult:
-        with Vertical():
-            yield Label(self._prompt)
-            yield Input(password=self._password)
+        yield Label(self._prompt)
+        yield Input(password=self._password)
 
-    @on(Input.Submitted)
-    def return_response(self, event: Input.Submitted) -> None:
-        self.dismiss(event.value)
+    @override
+    async def get_result(self) -> str:
+        return self.query_one(Input).value.strip()
 
 
-class TextualWorkerIO(IO):
+class TextualIO(IO):
     def __init__(self, app: App[Any], log: Log, progress_bar: ProgressBar) -> None:
         self._app = app
         self._log = log
@@ -55,7 +50,10 @@ class TextualWorkerIO(IO):
 
     @override
     async def prompt(self, prompt: str, password: bool = False) -> str:
-        return await self._app.push_screen_wait(IOScreen(prompt, password))
+        result = await self._app.push_screen_wait(SaveCancelDialogScreen(IODialogForm(prompt, password), title="Input"))
+        if result is CANCELLED:
+            return ""
+        return result
 
     @override
     async def print(self, message: str) -> None:

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/src/ynab_cli/adapters/ynab/util.py

@@ -55,6 +55,9 @@ async def run_asyncio_detailed(
             new_access_token = await io.prompt(
                 prompt="API rate limit exceeded. Enter a new access token", password=True
             )
+            if not new_access_token:
+                raise e
+
             client.token = new_access_token
             response = await asyncio_detailed(*args, **kwargs)
             parsed_data = get_parsed_response_data(response)

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/src/ynab_cli/domain/models/rules.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, Self
 
 from attrs import define as _attrs_define
 
@@ -18,20 +18,33 @@ class TransactionRule:
     #   See: https://api.ynab.com/v1#/Transactions/updateTransactions
     patch: models.SaveTransactionWithIdOrImportId | None = None
 
+    def to_dict(self) -> dict[str, Any]:
+        return {
+            "rules": self.rules,
+            "patch": self.patch.to_dict() if self.patch else None,
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> Self:
+        rules = [str(r) for r in data.get("rules", [])]
+        patch = None
+        if "patch" in data:
+            patch = models.SaveTransactionWithIdOrImportId.from_dict(data["patch"])
+
+        return cls(rules=rules, patch=patch)
+
 
 @_attrs_define
 class TransactionRules:
     transaction_rules: list[TransactionRule]
 
+    def to_dict(self) -> dict[str, Any]:
+        return {"transaction_rules": [rule.to_dict() for rule in self.transaction_rules]}
+
     @classmethod
-    def from_dict(cls, data: dict[str, Any]) -> "TransactionRules":
+    def from_dict(cls, data: dict[str, Any]) -> Self:
         transaction_rules = []
         for rule in data.get("transaction_rules", []):
-            rules = [str(r) for r in rule.get("rules", [])]
-            patch = None
-            if "patch" in rule:
-                patch = models.SaveTransactionWithIdOrImportId.from_dict(rule["patch"])
-
-            transaction_rules.append(TransactionRule(rules=rules, patch=patch))
+            transaction_rules.append(TransactionRule.from_dict(rule))
 
         return cls(transaction_rules=transaction_rules)

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

@@ -0,0 +1,45 @@
+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, *, client: ynab.AuthenticatedClient | None = None
+) -> AsyncIterator[models.BudgetSummary]:
+    try:
+        progress_total = 0
+
+        if client is None:
+            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+
+        async with client:
+            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)
+            await io.progress.update(total=progress_total)
+            for budget in budgets:
+                await io.progress.update(advance=1)
+                yield budget
+
+    except Exception as e:
+        if isinstance(e, util.ApiError) and e.status_code == 401:
+            await io.print("Invalid or expired access token. Please update your settings.")
+        elif isinstance(e, util.ApiError) and 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")
+    finally:
+        await io.progress.update(total=progress_total, completed=progress_total)

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/src/ynab_cli/domain/use_cases/categories.py

@@ -20,9 +20,16 @@ class ListUnusedParams(TypedDict):
     pass
 
 
-async def list_unused(settings: Settings, io: ports.IO, params: ListUnusedParams) -> AsyncIterator[models.Category]:
-    async with ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token) as client:
-        try:
+async def list_unused(
+    settings: Settings, io: ports.IO, params: ListUnusedParams, *, client: ynab.AuthenticatedClient | None = None
+) -> AsyncIterator[models.Category]:
+    try:
+        progress_total = 0
+
+        if client is None:
+            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+
+        async with client:
             category_groups = (
                 await util.get_asyncio_detailed(
                     io, get_categories.asyncio_detailed, settings.ynab.budget_id, client=client
@@ -31,16 +38,18 @@ async def list_unused(settings: Settings, io: ports.IO, params: ListUnusedParams
             category_groups.sort(key=lambda cg: cg.name)
 
             progress_total = len(category_groups)
+            await io.progress.update(total=progress_total)
             for category_group in category_groups:
-                await io.progress.update(total=progress_total, advance=1)
+                await io.progress.update(advance=1)
 
                 if _should_skip_category_or_group(category_or_group=category_group):
                     continue
 
                 progress_total += len(category_group.categories)
+                await io.progress.update(total=progress_total)
                 category_group.categories.sort(key=lambda c: c.name)
                 for category in category_group.categories:
-                    await io.progress.update(total=progress_total, advance=1)
+                    await io.progress.update(advance=1)
 
                     if _should_skip_category_or_group(category_or_group=category):
                         continue
@@ -60,20 +69,31 @@ async def list_unused(settings: Settings, io: ports.IO, params: ListUnusedParams
                     if not num_transactions:
                         yield category
 
-        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")
+    except Exception as e:
+        if isinstance(e, util.ApiError) and e.status_code == 401:
+            await io.print("Invalid or expired access token. Please update your settings.")
+        elif isinstance(e, util.ApiError) and 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")
+    finally:
+        await io.progress.update(total=progress_total, completed=progress_total)
 
 
 class ListAllParams(TypedDict):
     pass
 
 
-async def list_all(settings: Settings, io: ports.IO, params: ListAllParams) -> AsyncIterator[models.Category]:
-    async with ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token) as client:
-        try:
+async def list_all(
+    settings: Settings, io: ports.IO, params: ListAllParams, *, client: ynab.AuthenticatedClient | None = None
+) -> AsyncIterator[models.Category]:
+    try:
+        progress_total = 0
+
+        if client is None:
+            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+
+        async with client:
             category_groups = (
                 await util.get_asyncio_detailed(
                     io, get_categories.asyncio_detailed, settings.ynab.budget_id, client=client
@@ -82,24 +102,30 @@ async def list_all(settings: Settings, io: ports.IO, params: ListAllParams) -> A
             category_groups.sort(key=lambda cg: cg.name)
 
             progress_total = len(category_groups)
+            await io.progress.update(total=progress_total)
             for category_group in category_groups:
-                await io.progress.update(total=progress_total, advance=1)
+                await io.progress.update(advance=1)
 
                 if _should_skip_category_or_group(category_or_group=category_group):
                     continue
 
                 progress_total += len(category_group.categories)
+                await io.progress.update(total=progress_total)
                 category_group.categories.sort(key=lambda c: c.name)
                 for category in category_group.categories:
-                    await io.progress.update(total=progress_total, advance=1)
+                    await io.progress.update(advance=1)
 
                     if _should_skip_category_or_group(category_or_group=category):
                         continue
 
                     yield category
 
-        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")
+    except Exception as e:
+        if isinstance(e, util.ApiError) and e.status_code == 401:
+            await io.print("Invalid or expired access token. Please update your settings.")
+        elif isinstance(e, util.ApiError) and 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")
+    finally:
+        await io.progress.update(total=progress_total, completed=progress_total)

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/src/ynab_cli/domain/use_cases/payees.py

@@ -47,19 +47,22 @@ class NormalizeNamesParams(TypedDict):
 async def normalize_names(
     settings: Settings, io: ports.IO, params: NormalizeNamesParams, *, client: ynab.AuthenticatedClient | None = None
 ) -> AsyncIterator[tuple[models.Payee, str]]:
-    if client is None:
-        client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+    try:
+        progress_total = 0
 
-    async with client:
-        try:
+        if client is None:
+            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+
+        async with client:
             payees = (
                 await util.get_asyncio_detailed(io, get_payees.asyncio_detailed, settings.ynab.budget_id, client=client)
             ).data.payees
             payees.sort(key=lambda p: p.name)
 
             progress_total = len(payees)
+            await io.progress.update(total=progress_total)
             for payee in payees:
-                await io.progress.update(total=progress_total, advance=1)
+                await io.progress.update(advance=1)
 
                 if _should_skip_payee(payee=payee):
                     continue
@@ -78,11 +81,15 @@ async def normalize_names(
                             body=models.PatchPayeeWrapper(payee=models.SavePayee(name=normalized_name)),
                         )
 
-        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")
+    except Exception as e:
+        if isinstance(e, util.ApiError) and e.status_code == 401:
+            await io.print("Invalid or expired access token. Please update your settings.")
+        elif isinstance(e, util.ApiError) and 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")
+    finally:
+        await io.progress.update(total=progress_total, completed=progress_total)
 
 
 class ListDuplicatesParams(TypedDict):
@@ -92,11 +99,13 @@ class ListDuplicatesParams(TypedDict):
 async def list_duplicates(
     settings: Settings, io: ports.IO, params: ListDuplicatesParams, *, client: ynab.AuthenticatedClient | None = None
 ) -> AsyncIterator[tuple[models.Payee, models.Payee]]:
-    if client is None:
-        client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+    try:
+        progress_total = 0
+
+        if client is None:
+            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
 
-    async with client:
-        try:
+        async with client:
             possible_duplicates: dict[tuple[UUID, str], list[tuple[UUID, str]]] = {}
 
             payees = (
@@ -105,8 +114,9 @@ async def list_duplicates(
             payees.sort(key=lambda p: p.name)
 
             progress_total = len(payees)
+            await io.progress.update(total=progress_total)
             for idx, payee in enumerate(payees):
-                await io.progress.update(total=progress_total, advance=1)
+                await io.progress.update(advance=1)
 
                 if _should_skip_payee(payee=payee):
                     continue
@@ -134,11 +144,15 @@ async def list_duplicates(
 
                         yield (payee, filtered_payee)
 
-        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")
+    except Exception as e:
+        if isinstance(e, util.ApiError) and e.status_code == 401:
+            await io.print("Invalid or expired access token. Please update your settings.")
+        elif isinstance(e, util.ApiError) and 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")
+    finally:
+        await io.progress.update(total=progress_total, completed=progress_total)
 
 
 class ListUnusedParams(TypedDict):
@@ -148,19 +162,22 @@ class ListUnusedParams(TypedDict):
 async def list_unused(
     settings: Settings, io: ports.IO, params: ListUnusedParams, *, client: ynab.AuthenticatedClient | None = None
 ) -> AsyncIterator[models.Payee]:
-    if client is None:
-        client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+    try:
+        progress_total = 0
 
-    async with client:
-        try:
+        if client is None:
+            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+
+        async with client:
             payees = (
                 await util.get_asyncio_detailed(io, get_payees.asyncio_detailed, settings.ynab.budget_id, client=client)
             ).data.payees
             payees.sort(key=lambda p: p.name)
 
             progress_total = len(payees)
+            await io.progress.update(total=progress_total)
             for payee in payees:
-                await io.progress.update(total=progress_total, advance=1)
+                await io.progress.update(advance=1)
 
                 if _should_skip_payee(payee=payee):
                     continue
@@ -192,11 +209,15 @@ async def list_unused(
                             body=models.PatchPayeeWrapper(payee=models.SavePayee(name=new_name)),
                         )
 
-        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")
+    except Exception as e:
+        if isinstance(e, util.ApiError) and e.status_code == 401:
+            await io.print("Invalid or expired access token. Please update your settings.")
+        elif isinstance(e, util.ApiError) and 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")
+    finally:
+        await io.progress.update(total=progress_total, completed=progress_total)
 
 
 class ListAllParams(TypedDict):
@@ -206,27 +227,34 @@ class ListAllParams(TypedDict):
 async def list_all(
     settings: Settings, io: ports.IO, params: ListAllParams, *, client: ynab.AuthenticatedClient | None = None
 ) -> AsyncIterator[models.Payee]:
-    if client is None:
-        client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+    try:
+        progress_total = 0
+
+        if client is None:
+            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
 
-    async with client:
-        try:
+        async with client:
             payees = (
                 await util.get_asyncio_detailed(io, get_payees.asyncio_detailed, settings.ynab.budget_id, client=client)
             ).data.payees
             payees.sort(key=lambda p: p.name)
 
             progress_total = len(payees)
+            await io.progress.update(total=progress_total)
             for payee in payees:
-                await io.progress.update(total=progress_total, advance=1)
+                await io.progress.update(advance=1)
 
                 if _should_skip_payee(payee=payee):
                     continue
 
                 yield payee
 
-        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")
+    except Exception as e:
+        if isinstance(e, util.ApiError) and e.status_code == 401:
+            await io.print("Invalid or expired access token. Please update your settings.")
+        elif isinstance(e, util.ApiError) and 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")
+    finally:
+        await io.progress.update(total=progress_total, completed=progress_total)

{ynab_cli-0.5.2 → ynab_cli-0.5.4}/src/ynab_cli/domain/use_cases/transactions.py

@@ -44,10 +44,15 @@ class ApplyRulesParams(TypedDict):
 
 
 async def apply_rules(
-    settings: Settings, io: ports.IO, params: ApplyRulesParams
+    settings: Settings, io: ports.IO, params: ApplyRulesParams, *, client: ynab.AuthenticatedClient | None = None
 ) -> AsyncIterator[tuple[models.TransactionDetail, models.SaveTransactionWithIdOrImportId]]:
-    async with ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token) as client:
-        try:
+    try:
+        progress_total = 0
+
+        if client is None:
+            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+
+        async with client:
             transactions = (
                 await util.get_asyncio_detailed(
                     io,
@@ -62,8 +67,9 @@ async def apply_rules(
             save_transactions = []
 
             progress_total = len(transactions)
+            await io.progress.update(total=progress_total)
             for transaction in transactions:
-                await io.progress.update(total=progress_total, advance=1)
+                await io.progress.update(advance=1)
 
                 if _should_skip_transaction(transaction=transaction):
                     continue
@@ -86,8 +92,12 @@ async def apply_rules(
                     body=models.PatchTransactionsWrapper(transactions=save_transactions),
                 )
 
-        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")
+    except Exception as e:
+        if isinstance(e, util.ApiError) and e.status_code == 401:
+            await io.print("Invalid or expired access token. Please update your settings.")
+        elif isinstance(e, util.ApiError) and 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")
+    finally:
+        await io.progress.update(total=progress_total, completed=progress_total)