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

ynab_cli-0.6.1/.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.1}/CHANGELOG.md

@@ -5,6 +5,29 @@ 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.1 (2025-07-09)
+
+### Fix
+
+- fix issue with providing new token
+
+### Refactor
+
+- work towards using dependency injection container
+
+## 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.1}/Makefile

@@ -10,7 +10,7 @@ lint: .venv # run linters and type checkers
 	uv run mypy .
 
 test: .venv lint # run tests with coverage
-	uv run pytest --cov=src tests
+	uv run pytest --cov-report term-missing:skip-covered --cov=src tests
 
 clean: # clean up build artifacts and caches
 	rm -f .coverage

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ynab-cli
-Version: 0.5.4
+Version: 0.6.1
 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,17 +19,20 @@ 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
 Requires-Dist: httpx~=0.28
+Requires-Dist: lagom~=2.7
 Requires-Dist: python-dotenv~=1.1
 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.6
 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.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ynab-cli"
-version = "0.5.4"
+version = "0.6.1"
 description = "YNAB Command Line Interface"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -33,17 +33,20 @@ classifiers = [
 ]
 
 dependencies = [
+  "anyio~=4.9",
   "attrs~=25.3",
   "click-default-group~=1.2",
   "click~=8.2",
   "httpx~=0.28",
+  "lagom~=2.7",
   "python-dotenv~=1.1",
   "rapidfuzz~=3.13",
   "rich~=14.0",
   "rule-engine~=4.5",
   "textual-fspicker~=0.4",
-  "textual~=3.3",
+  "textual~=3.6",
   "typing-extensions~=4.14",
+  "uvloop~=0.21",
 ]
 
 [project.urls]
@@ -59,18 +62,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 +139,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.1}/src/ynab_cli/adapters/rich/io.py

@@ -6,8 +6,9 @@ from ynab_cli.domain.ports.io import IO, Progress
 
 
 class RichProgress(Progress):
-    def __init__(self, progress_info: tuple[rich_progress.Progress, rich_progress.TaskID]) -> None:
-        self._progress, self._task_id = progress_info
+    def __init__(self, progress: rich_progress.Progress) -> None:
+        self._progress = progress
+        self._task_id = progress.add_task("Loading...")
 
     @override
     async def update(
@@ -20,10 +21,9 @@ class RichProgress(Progress):
 
 
 class RichIO(IO):
-    def __init__(self, progress_info: tuple[rich_progress.Progress, rich_progress.TaskID]) -> None:
-        progress, _ = progress_info
+    def __init__(self, progress: rich_progress.Progress) -> None:
         self._progress = progress
-        self.progress = RichProgress(progress_info)
+        self.progress = RichProgress(self._progress)
 
     @override
     async def prompt(self, prompt: str, password: bool = False) -> str:

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

@@ -58,7 +58,19 @@ async def run_asyncio_detailed(
             if not new_access_token:
                 raise e
 
+            #
+            # Update the client with the new access token
+            # Also need to update the headers in the underlying
+            # HTTPX clients if they are set up.
+            #
             client.token = new_access_token
+            auth_header = f"{client.prefix} {client.token}" if client.prefix else client.token
+            client._headers[client.auth_header_name] = auth_header
+            if client._async_client:
+                client._async_client.headers[client.auth_header_name] = auth_header
+            if client._client:
+                client._client.headers[client.auth_header_name] = auth_header
+
             response = await asyncio_detailed(*args, **kwargs)
             parsed_data = get_parsed_response_data(response)
         else:

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

@@ -0,0 +1,47 @@
+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.settings import Settings
+
+
+class ListAllParams(TypedDict):
+    pass
+
+
+class ListAll:
+    """Use case for listing all budgets."""
+
+    def __init__(self, io: ports.IO, client: ynab.AuthenticatedClient):
+        self._io = io
+        self._client = client
+
+    async def __call__(self, settings: Settings, params: ListAllParams) -> AsyncIterator[models.BudgetSummary]:
+        try:
+            progress_total = 0
+
+            budgets = (
+                await util.get_asyncio_detailed(
+                    self._io, get_budgets.asyncio_detailed, include_accounts=False, client=self._client
+                )
+            ).data.budgets
+            budgets.sort(key=lambda b: b.name)
+
+            progress_total = len(budgets)
+            await self._io.progress.update(total=progress_total)
+            for budget in budgets:
+                await self._io.progress.update(advance=1)
+                yield budget
+
+        except Exception as e:
+            if isinstance(e, util.ApiError) and e.status_code == 401:
+                await self._io.print("Invalid or expired access token. Please update your settings.")
+            elif isinstance(e, util.ApiError) and e.status_code == 429:
+                await self._io.print("API rate limit exceeded. Try again later, or get a new access token.")
+            else:
+                await self._io.print(f"Exception when calling YNAB: {e}")
+        finally:
+            await self._io.progress.update(total=progress_total, completed=progress_total)

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

@@ -6,7 +6,6 @@ from ynab_cli.adapters.ynab import models, util
 from ynab_cli.adapters.ynab.api.categories import get_categories
 from ynab_cli.adapters.ynab.api.transactions import get_transactions_by_category
 from ynab_cli.domain import ports
-from ynab_cli.domain.constants import YNAB_API_URL
 from ynab_cli.domain.settings import Settings
 
 
@@ -20,47 +19,48 @@ class ListUnusedParams(TypedDict):
     pass
 
 
-async def list_unused(
-    settings: Settings, io: ports.IO, params: ListUnusedParams, *, client: ynab.AuthenticatedClient | None = None
-) -> AsyncIterator[models.Category]:
-    try:
-        progress_total = 0
+class ListUnused:
+    """Use case for listing unused categories."""
 
-        if client is None:
-            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+    def __init__(self, io: ports.IO, client: ynab.AuthenticatedClient):
+        self._io = io
+        self._client = client
+
+    async def __call__(self, settings: Settings, params: ListUnusedParams) -> AsyncIterator[models.Category]:
+        try:
+            progress_total = 0
 
-        async with client:
             category_groups = (
                 await util.get_asyncio_detailed(
-                    io, get_categories.asyncio_detailed, settings.ynab.budget_id, client=client
+                    self._io, get_categories.asyncio_detailed, settings.ynab.budget_id, client=self._client
                 )
             ).data.category_groups
             category_groups.sort(key=lambda cg: cg.name)
 
             progress_total = len(category_groups)
-            await io.progress.update(total=progress_total)
+            await self._io.progress.update(total=progress_total)
             for category_group in category_groups:
-                await io.progress.update(advance=1)
+                await self._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)
+                await self._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(advance=1)
+                    await self._io.progress.update(advance=1)
 
                     if _should_skip_category_or_group(category_or_group=category):
                         continue
 
                     transactions = (
                         await util.get_asyncio_detailed(
-                            io,
+                            self._io,
                             get_transactions_by_category.asyncio_detailed,
                             settings.ynab.budget_id,
                             str(category.id),
-                            client=client,
+                            client=self._client,
                         )
                     ).data.transactions
                     num_transactions = len(transactions)
@@ -69,63 +69,64 @@ async def list_unused(
                     if not num_transactions:
                         yield category
 
-    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)
+        except Exception as e:
+            if isinstance(e, util.ApiError) and e.status_code == 401:
+                await self._io.print("Invalid or expired access token. Please update your settings.")
+            elif isinstance(e, util.ApiError) and e.status_code == 429:
+                await self._io.print("API rate limit exceeded. Try again later, or get a new access token.")
+            else:
+                await self._io.print(f"Exception when calling YNAB: {e}")
+        finally:
+            await self._io.progress.update(total=progress_total, completed=progress_total)
 
 
 class ListAllParams(TypedDict):
     pass
 
 
-async def list_all(
-    settings: Settings, io: ports.IO, params: ListAllParams, *, client: ynab.AuthenticatedClient | None = None
-) -> AsyncIterator[models.Category]:
-    try:
-        progress_total = 0
+class ListAll:
+    """Use case for listing all categories."""
+
+    def __init__(self, io: ports.IO, client: ynab.AuthenticatedClient):
+        self._io = io
+        self._client = client
 
-        if client is None:
-            client = ynab.AuthenticatedClient(base_url=YNAB_API_URL, token=settings.ynab.access_token)
+    async def __call__(self, settings: Settings, params: ListAllParams) -> AsyncIterator[models.Category]:
+        try:
+            progress_total = 0
 
-        async with client:
             category_groups = (
                 await util.get_asyncio_detailed(
-                    io, get_categories.asyncio_detailed, settings.ynab.budget_id, client=client
+                    self._io, get_categories.asyncio_detailed, settings.ynab.budget_id, client=self._client
                 )
             ).data.category_groups
             category_groups.sort(key=lambda cg: cg.name)
 
             progress_total = len(category_groups)
-            await io.progress.update(total=progress_total)
+            await self._io.progress.update(total=progress_total)
             for category_group in category_groups:
-                await io.progress.update(advance=1)
+                await self._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)
+                await self._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(advance=1)
+                    await self._io.progress.update(advance=1)
 
                     if _should_skip_category_or_group(category_or_group=category):
                         continue
 
                     yield category
 
-    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)
+        except Exception as e:
+            if isinstance(e, util.ApiError) and e.status_code == 401:
+                await self._io.print("Invalid or expired access token. Please update your settings.")
+            elif isinstance(e, util.ApiError) and e.status_code == 429:
+                await self._io.print("API rate limit exceeded. Try again later, or get a new access token.")
+            else:
+                await self._io.print(f"Exception when calling YNAB: {e}")
+        finally:
+            await self._io.progress.update(total=progress_total, completed=progress_total)