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

ynab_cli-0.6.0/.github/.copilot-instructions.md

@@ -0,0 +1,191 @@
+# YNAB CLI - Copilot Instructions
+
+## Project Overview
+
+This is a command-line interface for interacting with YNAB (You Need A Budget) written in Python. The project follows clean architecture principles with ports and adapters pattern.
+
+## Architecture
+
+The project uses a layered architecture:
+
+- `src/ynab_cli/domain/`: Core business logic, models, and ports (interfaces)
+- `src/ynab_cli/adapters/`: External adapters (YNAB API, Rich UI, Textual TUI)
+- `src/ynab_cli/host/`: Application entry points and framework integration (Click CLI, Textual app)
+
+### Key Patterns
+
+1. **Ports and Adapters**: Domain defines protocols/interfaces, adapters implement them
+2. **Dependency Injection**: Dependencies are injected through constructors
+3. **Async/Await**: Most operations are async for better I/O handling
+4. **Type Safety**: Heavy use of type hints and protocols
+
+## Coding Standards
+
+### Python Version & Dependencies
+- Target Python 3.11+
+- Use `uv` for dependency management
+- All dependencies defined in `pyproject.toml`
+
+### Code Style
+- Follow PEP 8
+- Use type hints for all function parameters and return values
+- Prefer `typing_extensions` imports for newer typing features
+- Use `attrs` for data classes with `@define` decorator
+- Use `@override` decorator from `typing_extensions` when overriding methods in protocols or base classes
+
+### Async Patterns
+- Most I/O operations should be async
+- Use `anyio` for async utilities when needed
+- Progress tracking should be async-compatible
+
+### Error Handling
+- Use proper exception types
+- Handle API errors gracefully
+- Provide meaningful error messages to users
+
+## Testing Guidelines
+
+### Test Structure
+- Unit tests in `tests/unit/` mirroring `src/` structure
+- Use pytest as the testing framework
+- All test functions should have proper type annotations
+- Test classes should be named `Test<ClassName>`
+- Test methods should be descriptive: `test_<method_name>_<scenario>`
+
+### Mocking
+- Use `unittest.mock` for mocking external dependencies
+- Mock at the adapter level, not domain level
+- Use `MagicMock` for complex objects, `Mock` for simple ones
+
+### Test Patterns
+```python
+from typing import Any
+from unittest.mock import MagicMock, Mock
+import pytest
+
+class TestMyClass:
+    def test_method_name_success_scenario(self) -> None:
+        """Test description of what is being tested."""
+        # Arrange
+        mock_dependency = Mock()
+        instance = MyClass(mock_dependency)
+        
+        # Act
+        result = instance.method_name()
+        
+        # Assert
+        assert result == expected_value
+        mock_dependency.some_method.assert_called_once()
+```
+
+## Domain Models
+
+### Data Classes
+- Use `@attrs.define` for data classes
+- Implement `to_dict()` and `from_dict()` for serialization when needed
+- Use proper type hints including `Self` for class methods
+
+```python
+from typing import Any, Self
+from attrs import define
+
+@define
+class MyModel:
+    field: str
+    optional_field: int | None = None
+    
+    def to_dict(self) -> dict[str, Any]:
+        return {"field": self.field, "optional_field": self.optional_field}
+    
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> Self:
+        return cls(field=data["field"], optional_field=data.get("optional_field"))
+```
+
+### Protocols
+- Define interfaces as protocols in `domain/ports/`
+- Use `typing.Protocol` for structural typing
+- Mark implementation methods with `@override`
+
+## UI Frameworks
+
+### Rich (Progress & Prompts)
+- Used for CLI progress bars and user prompts
+- Implement `Progress` and `IO` protocols
+- Handle console stop/start for prompts
+
+### Textual (TUI)
+- Used for interactive terminal UI
+- Follow Textual app patterns
+- Use proper CSS for styling
+- Handle async operations properly
+
+### Click (CLI Framework)
+- Use Click for command-line interface
+- Use `click-default-group` for default commands
+- Implement proper help text and options
+- Use context objects for passing settings
+
+## API Integration
+
+### YNAB API
+- All API models should be in `adapters/ynab/models/`
+- Use proper error handling for HTTP requests
+- Implement rate limiting if needed
+- Use `httpx` for HTTP client
+
+## File Organization
+
+### Import Order
+1. Standard library imports
+2. Third-party imports
+3. Local imports (domain, then adapters, then host)
+
+### Module Structure
+- Keep modules focused and cohesive
+- Use `__init__.py` for public APIs
+- Private modules should have underscore prefix
+
+## Common Patterns
+
+### Progress Tracking
+```python
+async def long_running_operation(io: IO) -> None:
+    await io.progress.update(total=100)
+    for i in range(100):
+        # Do work
+        await io.progress.update(advance=1)
+```
+
+### Settings & Configuration
+- Use environment variables with `python-dotenv`
+- Settings objects should be immutable
+- Pass settings through dependency injection
+
+### Error Messages
+- Provide actionable error messages
+- Include context about what was being attempted
+- Use appropriate log levels
+
+## Development Workflow
+
+1. Create feature branches from main
+2. Write tests first (TDD when possible)
+3. Implement functionality
+4. Ensure all tests pass
+5. Run linting and formatting (`make lint`)
+6. Create pull request with descriptive title and description
+
+## Performance Considerations
+
+- Use async I/O for network operations
+- Implement progress tracking for long operations
+- Consider memory usage for large datasets
+- Use appropriate data structures for lookups
+
+## Security
+
+- Never log sensitive data (API keys, personal info)
+- Use environment variables for secrets
+- Validate user inputs
+- Handle API rate limits gracefully

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

@@ -5,6 +5,19 @@ 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.6.0 (2025-06-28)
+
+### Feat
+
+- use anyio and uvloop
+
+### Fix
+
+- **tests**: adding moar tests
+- **tests**: added tests for a bunch of things
+- **deps**: bump textual from 3.3.0 to 3.4.0
+- **tui**: fix some ui issues and clean up some code
+
 ## v0.5.4 (2025-06-10)
 
 ### Fix

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ynab-cli
-Version: 0.5.4
+Version: 0.6.0
 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/
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Office/Business :: Financial
 Classifier: Topic :: Utilities
 Requires-Python: >=3.11
+Requires-Dist: anyio~=4.9
 Requires-Dist: attrs~=25.3
 Requires-Dist: click-default-group~=1.2
 Requires-Dist: click~=8.2
@@ -28,8 +29,9 @@ Requires-Dist: rapidfuzz~=3.13
 Requires-Dist: rich~=14.0
 Requires-Dist: rule-engine~=4.5
 Requires-Dist: textual-fspicker~=0.4
-Requires-Dist: textual~=3.3
+Requires-Dist: textual~=3.5
 Requires-Dist: typing-extensions~=4.14
+Requires-Dist: uvloop~=0.21
 Description-Content-Type: text/markdown
 
 # YNAB CLI

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

@@ -1,6 +1,6 @@
 [project]
 name = "ynab-cli"
-version = "0.5.4"
+version = "0.6.0"
 description = "YNAB Command Line Interface"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -33,6 +33,7 @@ classifiers = [
 ]
 
 dependencies = [
+  "anyio~=4.9",
   "attrs~=25.3",
   "click-default-group~=1.2",
   "click~=8.2",
@@ -42,8 +43,9 @@ dependencies = [
   "rich~=14.0",
   "rule-engine~=4.5",
   "textual-fspicker~=0.4",
-  "textual~=3.3",
+  "textual~=3.5",
   "typing-extensions~=4.14",
+  "uvloop~=0.21",
 ]
 
 [project.urls]
@@ -59,18 +61,18 @@ ynab-cli = "ynab_cli.host.cli:main"
 
 [dependency-groups]
 dev = [
-  "commitizen>=4.8.2",
+  "commitizen>=4.8.3",
   "factory-boy>=3.3.3",
   "mkdocs-click>=0.9.0",
   "mkdocs-material>=9.6.14",
   "mkdocs>=1.6.1",
   "mypy>=1.16.0",
-  "pytest-asyncio>=1.0.0",
-  "pytest-cov>=6.1.1",
+  "pytest-cov>=6.2.1",
   "pytest-mock>=3.14.1",
-  "pytest>=8.4.0",
-  "ruff>=0.11.12",
+  "pytest>=8.4.1",
+  "ruff>=0.12.1",
   "textual-dev>=1.7.0",
+  "trio>=0.30.0",
   "types-python-dateutil>=2.9.0.20250516",
 ]
 
@@ -136,6 +138,12 @@ max-complexity = 70
 builtins-ignorelist = ["type", "id"]
 
 
+[tool.coverage.run]
+omit = [
+  "src/ynab_cli/adapters/ynab/**/*",
+]
+
+
 [tool.commitizen]
 name = "cz_conventional_commits"
 annotated_tag = true

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/domain/use_cases/budgets.py

@@ -24,7 +24,7 @@ async def list_all(
 
         async with client:
             budgets = (
-                await util.get_asyncio_detailed(io, get_budgets.asyncio_detailed, include_accounts=True, client=client)
+                await util.get_asyncio_detailed(io, get_budgets.asyncio_detailed, include_accounts=False, client=client)
             ).data.budgets
             budgets.sort(key=lambda b: b.name)
 
@@ -40,6 +40,6 @@ async def list_all(
         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")
+            await io.print(f"Exception when calling YNAB: {e}")
     finally:
         await io.progress.update(total=progress_total, completed=progress_total)

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

@@ -75,7 +75,7 @@ async def list_unused(
         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")
+            await io.print(f"Exception when calling YNAB: {e}")
     finally:
         await io.progress.update(total=progress_total, completed=progress_total)
 
@@ -126,6 +126,6 @@ async def list_all(
         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")
+            await io.print(f"Exception when calling YNAB: {e}")
     finally:
         await io.progress.update(total=progress_total, completed=progress_total)

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

@@ -87,7 +87,7 @@ async def normalize_names(
         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")
+            await io.print(f"Exception when calling YNAB: {e}")
     finally:
         await io.progress.update(total=progress_total, completed=progress_total)
 
@@ -150,7 +150,7 @@ async def list_duplicates(
         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")
+            await io.print(f"Exception when calling YNAB: {e}")
     finally:
         await io.progress.update(total=progress_total, completed=progress_total)
 
@@ -215,7 +215,7 @@ async def list_unused(
         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")
+            await io.print(f"Exception when calling YNAB: {e}")
     finally:
         await io.progress.update(total=progress_total, completed=progress_total)
 
@@ -255,6 +255,6 @@ async def list_all(
         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")
+            await io.print(f"Exception when calling YNAB: {e}")
     finally:
         await io.progress.update(total=progress_total, completed=progress_total)

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

@@ -98,6 +98,6 @@ async def apply_rules(
         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")
+            await io.print(f"Exception when calling YNAB: {e}")
     finally:
         await io.progress.update(total=progress_total, completed=progress_total)

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/host/cli.py

@@ -35,4 +35,4 @@ def main() -> None:
 
 
 if __name__ == "__main__":
-    main()
+    main()  # pragma: no cover

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/host/click/commands/budgets.py

@@ -1,5 +1,4 @@
-import asyncio
-
+import anyio
 import click
 from rich.table import Table
 
@@ -38,7 +37,11 @@ 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())))
+    anyio.run(
+        _list_all,
+        ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()),
+        backend_options={"use_uvloop": True},
+    )
 
 
 @click.group()

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/host/click/commands/categories.py

@@ -1,5 +1,4 @@
-import asyncio
-
+import anyio
 import click
 from rich.table import Table
 
@@ -68,7 +67,11 @@ def list_unused(ctx: click.Context) -> None:
     """List unused categories in the YNAB budget."""
 
     ctx.ensure_object(dict)
-    asyncio.run(_list_unused(ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())))
+    anyio.run(
+        _list_unused,
+        ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()),
+        backend_options={"use_uvloop": True},
+    )
 
 
 @click.command()
@@ -77,7 +80,11 @@ def list_all(ctx: click.Context) -> None:
     """List all categories in the YNAB budget."""
 
     ctx.ensure_object(dict)
-    asyncio.run(_list_all(ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())))
+    anyio.run(
+        _list_all,
+        ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()),
+        backend_options={"use_uvloop": True},
+    )
 
 
 @click.group()

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/host/click/commands/payees.py

@@ -1,5 +1,4 @@
-import asyncio
-
+import anyio
 import click
 from rich.table import Table
 
@@ -112,7 +111,11 @@ def normalize_names(ctx: click.Context) -> None:
     """Normalize payee names in the YNAB budget."""
 
     ctx.ensure_object(dict)
-    asyncio.run(_normalize_names(ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())))
+    anyio.run(
+        _normalize_names,
+        ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()),
+        backend_options={"use_uvloop": True},
+    )
 
 
 @click.command()
@@ -121,7 +124,11 @@ def list_duplicates(ctx: click.Context) -> None:
     """List duplicate payees in the YNAB budget."""
 
     ctx.ensure_object(dict)
-    asyncio.run(_list_duplicates(ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())))
+    anyio.run(
+        _list_duplicates,
+        ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()),
+        backend_options={"use_uvloop": True},
+    )
 
 
 @click.command()
@@ -131,7 +138,12 @@ def list_unused(ctx: click.Context, prefix_unused: bool) -> None:
     """List unused payees in the YNAB budget."""
 
     ctx.ensure_object(dict)
-    asyncio.run(_list_unused(ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()), prefix_unused))
+    anyio.run(
+        _list_unused,
+        ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()),
+        prefix_unused,
+        backend_options={"use_uvloop": True},
+    )
 
 
 @click.command()
@@ -140,7 +152,11 @@ def list_all(ctx: click.Context) -> None:
     """List all payees in the YNAB budget."""
 
     ctx.ensure_object(dict)
-    asyncio.run(_list_all(ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings())))
+    anyio.run(
+        _list_all,
+        ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()),
+        backend_options={"use_uvloop": True},
+    )
 
 
 @click.group()

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/host/click/commands/transactions.py

@@ -1,7 +1,7 @@
-import asyncio
 import json
 from typing import IO, Any
 
+import anyio
 import click
 from rich.table import Table
 
@@ -62,7 +62,12 @@ def apply_rules(ctx: click.Context, rules_file: IO[Any]) -> None:
 
     transaction_rules = rules.TransactionRules.from_dict(json.load(rules_file))
 
-    asyncio.run(_apply_rules(ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()), transaction_rules))
+    anyio.run(
+        _apply_rules,
+        ctx.obj.get(CONTEXT_KEY_SETTINGS, Settings()),
+        transaction_rules,
+        backend_options={"use_uvloop": True},
+    )
 
 
 @click.group()

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/host/textual/app.py

@@ -5,38 +5,12 @@ from textual.app import App, ComposeResult
 from textual.binding import Binding, BindingType
 from textual.containers import Horizontal, Vertical
 from textual.reactive import reactive
-from textual.widgets import Checkbox, Footer, Header, Input, Label, TabbedContent, TabPane
+from textual.widgets import Checkbox, Footer, Header, Input, Label, TabbedContent
 from typing_extensions import override
 
 from ynab_cli.domain.settings import Settings, YnabSettings
-from ynab_cli.host.textual.widgets.categories.tabs import CategoriesTabs
 from ynab_cli.host.textual.widgets.common.dialogs import CANCELLED, DialogForm, SaveCancelDialogScreen
-from ynab_cli.host.textual.widgets.common.runnable_widget import RunnableWidget
-from ynab_cli.host.textual.widgets.payees.tabs import PayeesTabs
-from ynab_cli.host.textual.widgets.transactions.tabs import TransactionsTabs
-
-
-class CommandTabs(RunnableWidget):
-    @override
-    def compose(self) -> ComposeResult:
-        with TabbedContent():
-            with TabPane("Transactions", id="transactions"):
-                yield TransactionsTabs().data_bind(settings=CommandTabs.settings)
-            with TabPane("Categories", id="categories"):
-                yield CategoriesTabs().data_bind(settings=CommandTabs.settings)
-            with TabPane("Payees", id="payees"):
-                yield PayeesTabs().data_bind(settings=CommandTabs.settings)
-
-    @override
-    async def run_command(self) -> None:
-        tabbed_content = self.query_one(TabbedContent)
-        if tabbed_content.active_pane:
-            if tabbed_content.active_pane.id == "transactions":
-                await self.query_one(TransactionsTabs).run_command()
-            elif tabbed_content.active_pane.id == "categories":
-                await self.query_one(CategoriesTabs).run_command()
-            elif tabbed_content.active_pane.id == "payees":
-                await self.query_one(PayeesTabs).run_command()
+from ynab_cli.host.textual.widgets.tabs import CommandTabs
 
 
 class SettingsDialogForm(DialogForm[Settings]):
@@ -81,8 +55,9 @@ class YnabCliApp(App[None]):
 
     BINDINGS: ClassVar[list[BindingType]] = [
         Binding("ctrl+c", "quit", "Quit", show=True, priority=True),
-        Binding("s", "settings", "Settings", show=True, priority=False),
-        Binding("r", "run", "Run", show=True, priority=False),
+        Binding("s", "settings", "Application Settings", show=True, priority=False),
+        Binding("p", "parameters", "Command Parameters", show=True, priority=False),
+        Binding("r", "run", "Run Command", show=True, priority=False),
     ]
 
     settings: reactive[Settings] = reactive(Settings())
@@ -104,17 +79,21 @@ class YnabCliApp(App[None]):
     def on_mount(self) -> None:
         self.query_one(CommandTabs).query_one(TabbedContent).focus()
 
-    async def action_run(self) -> None:
-        command_tabs = self.query_one(CommandTabs)
-        await command_tabs.run_command()
-
     async def action_settings(self) -> None:
-        self._get_settings()
+        self._get_settings_worker()
 
     @work(exclusive=True)
-    async def _get_settings(self) -> None:
+    async def _get_settings_worker(self) -> None:
         result = await self.push_screen_wait(
             SaveCancelDialogScreen(SettingsDialogForm(self.settings), title="Settings")
         )
         if result is not CANCELLED:
             self.settings = result
+
+    async def action_parameters(self) -> None:
+        command_tabs = self.query_one(CommandTabs)
+        await command_tabs.active_command().get_command_params()
+
+    async def action_run(self) -> None:
+        command_tabs = self.query_one(CommandTabs)
+        await command_tabs.active_command().run_command()

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/host/textual/app.tcss

@@ -9,22 +9,22 @@ CommandTabs {
         height: auto;
         padding-top: 1;
 
-        & DataTable {
-            border: solid $secondary;
-            height: 1fr;
-        }
+        & CommandWidget {
+            height: auto;
 
-        & Log {
-            border: solid $secondary;
-            height: 8;
+            & DataTable {
+                border: solid $secondary;
+                height: 1fr;
+            }
+
+            & Log {
+                border: solid $secondary;
+                height: 8;
+            }
         }
     }
 }
 
-RunnableWidget {
-    height: auto;
-}
-
 DialogScreen {
     align: center middle;
 

{ynab_cli-0.5.4 → ynab_cli-0.6.0}/src/ynab_cli/host/textual/cli.py

@@ -1,6 +1,6 @@
-import asyncio
 import logging
 
+import anyio
 import click
 from textual.logging import TextualHandler
 
@@ -39,4 +39,8 @@ def tui(
         handlers=[TextualHandler()],
     )
 
-    asyncio.run(_tui(ctx.obj[CONTEXT_KEY_SETTINGS]))
+    anyio.run(
+        _tui,
+        ctx.obj[CONTEXT_KEY_SETTINGS],
+        backend_options={"use_uvloop": True},
+    )