pytaskwarrior 0.4.3__tar.gz → 1.0.0__tar.gz

pytaskwarrior-1.0.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: pytaskwarrior
+Version: 1.0.0
+Summary: Taskwarrior wrapper python module
+Author-email: sznicolas <sznicolas@users.noreply.github.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sznicolas/pytaskwarrior/
+Project-URL: Repository, https://github.com/sznicolas/pytaskwarrior/
+Project-URL: Issues, https://github.com/sznicolas/pytaskwarrior/issues
+Project-URL: Changelog, https://github.com/sznicolas/pytaskwarrior/blob/main/CHANGELOG.md
+Keywords: taskwarrior,task,productivity,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.11.7
+Dynamic: license-file
+
+# pytaskwarrior
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Tests](https://github.com/sznicolas/pytaskwarrior/workflows/CI/badge.svg)](https://github.com/sznicolas/pytaskwarrior/actions)
+[![Coverage](https://img.shields.io/badge/coverage-96%25-brightgreen.svg)](https://github.com/sznicolas/pytaskwarrior)
+[![PyPI version](https://img.shields.io/pypi/v/pytaskwarrior.svg)](https://pypi.org/project/pytaskwarrior/)
+
+A modern Python wrapper for [TaskWarrior](https://taskwarrior.org/), the command-line task management tool.
+
+**v1.0.0**: Production-ready with 132 tests (96% coverage), strict type checking, and professional-grade code quality. Zero linting errors, full async-safe subprocess handling, and PEP 561 type hints for IDE support.
+
+## Features
+
+- ✅ Full CRUD operations for tasks
+- ✅ Type-safe with Pydantic models
+- ✅ Context management
+- ✅ UDA (User Defined Attributes) support
+- ✅ Recurring tasks and annotations
+
+## Requirements
+
+- Python 3.12+
+- TaskWarrior 3.4+ installed
+
+## Installation
+
+```bash
+pip install pytaskwarrior
+```
+
+## Quick Start
+
+```python
+from taskwarrior import TaskWarrior, TaskInputDTO, Priority
+
+tw = TaskWarrior()
+
+# Create a task
+task = TaskInputDTO(
+    description="Important meeting",
+    priority=Priority.HIGH,
+    project="work",
+    due="friday"
+)
+added = tw.add_task(task)
+
+# Get all pending tasks
+for t in tw.get_tasks():
+    print(f"[{t.priority or '-'}] {t.description}")
+
+# Complete a task
+tw.done_task(added.uuid)
+```
+
+## Documentation
+
+Full documentation: [GitHub Repository](https://github.com/sznicolas/pytaskwarrior/)

pytaskwarrior-1.0.0/PYPI_README.md

@@ -0,0 +1,59 @@
+# pytaskwarrior
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Tests](https://github.com/sznicolas/pytaskwarrior/workflows/CI/badge.svg)](https://github.com/sznicolas/pytaskwarrior/actions)
+[![Coverage](https://img.shields.io/badge/coverage-96%25-brightgreen.svg)](https://github.com/sznicolas/pytaskwarrior)
+[![PyPI version](https://img.shields.io/pypi/v/pytaskwarrior.svg)](https://pypi.org/project/pytaskwarrior/)
+
+A modern Python wrapper for [TaskWarrior](https://taskwarrior.org/), the command-line task management tool.
+
+**v1.0.0**: Production-ready with 132 tests (96% coverage), strict type checking, and professional-grade code quality. Zero linting errors, full async-safe subprocess handling, and PEP 561 type hints for IDE support.
+
+## Features
+
+- ✅ Full CRUD operations for tasks
+- ✅ Type-safe with Pydantic models
+- ✅ Context management
+- ✅ UDA (User Defined Attributes) support
+- ✅ Recurring tasks and annotations
+
+## Requirements
+
+- Python 3.12+
+- TaskWarrior 3.4+ installed
+
+## Installation
+
+```bash
+pip install pytaskwarrior
+```
+
+## Quick Start
+
+```python
+from taskwarrior import TaskWarrior, TaskInputDTO, Priority
+
+tw = TaskWarrior()
+
+# Create a task
+task = TaskInputDTO(
+    description="Important meeting",
+    priority=Priority.HIGH,
+    project="work",
+    due="friday"
+)
+added = tw.add_task(task)
+
+# Get all pending tasks
+for t in tw.get_tasks():
+    print(f"[{t.priority or '-'}] {t.description}")
+
+# Complete a task
+tw.done_task(added.uuid)
+```
+
+## Documentation
+
+Full documentation: [GitHub Repository](https://github.com/sznicolas/pytaskwarrior/)

pytaskwarrior-1.0.0/README.md

@@ -0,0 +1,341 @@
+# pytaskwarrior
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Tests](https://github.com/sznicolas/pytaskwarrior/workflows/CI/badge.svg)](https://github.com/sznicolas/pytaskwarrior/actions)
+[![Coverage](https://img.shields.io/badge/coverage-96%25-brightgreen.svg)](https://github.com/sznicolas/pytaskwarrior)
+[![PyPI version](https://img.shields.io/pypi/v/pytaskwarrior.svg)](https://pypi.org/project/pytaskwarrior/)
+
+A modern Python wrapper for [TaskWarrior](https://taskwarrior.org/) v3.4, the command-line task management tool.
+
+**v1.0.0**: Production-ready with 132 tests (96% coverage), strict type checking, and professional-grade code quality. Zero linting errors, full async-safe subprocess handling, and PEP 561 type hints for IDE support.
+
+## Features
+
+- ✅ **Full CRUD operations** - Create, read, update, delete tasks
+- ✅ **Type-safe** - Pydantic models with full type hints
+- ✅ **Context management** - Define, apply, and switch contexts
+- ✅ **UDA support** - User Defined Attributes
+- ✅ **Recurring tasks** - Full recurrence support
+- ✅ **Annotations** - Add notes to tasks
+- ✅ **Date calculations** - Use TaskWarrior's date expressions
+
+## Requirements
+
+- Python 3.12+
+- TaskWarrior 3.4+ installed and accessible via `task` command
+
+## Installation
+
+```bash
+pip install pytaskwarrior==1.0.0
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/sznicolas/pytaskwarrior.git
+cd pytaskwarrior
+pip install -e .
+```
+
+## Quick Start
+
+### Running the bundled examples in isolation
+
+The examples in the examples/ directory are designed to be independent of your personal TaskWarrior configuration. They use the bundled examples/taskrc_example and examples/task_data so they won't modify your default ~/.taskrc or TaskWarrior database.
+
+To run an example script (from the repository root):
+
+```bash
+python examples/example_1_basic.py
+```
+
+To run the task CLI manually with the same resources (from the repository root):
+
+```bash
+task rc:examples/taskrc_example rc.data.location=examples/task_data <command>
+```
+
+Replace the relative paths with absolute paths (for example, $(pwd)/examples/taskrc_example) if you prefer.
+
+
+```python
+from taskwarrior import TaskWarrior, TaskInputDTO, Priority
+
+# Initialize TaskWarrior (uses default ~/.taskrc)
+tw = TaskWarrior()
+
+# Create a simple task
+task = TaskInputDTO(description="Buy groceries")
+added_task = tw.add_task(task)
+print(f"Created task #{added_task.index}: {added_task.uuid}")
+
+# Create a task with more details
+urgent_task = TaskInputDTO(
+    description="Finish project report",
+    priority=Priority.HIGH,
+    project="work",
+    tags=["urgent", "report"],
+    due="friday",  # TaskWarrior date expressions work!
+)
+tw.add_task(urgent_task)
+
+# Get all pending tasks
+tasks = tw.get_tasks()
+for t in tasks:
+    print(f"[{t.priority or '-'}] {t.description}")
+
+# Complete a task
+tw.done_task(added_task.uuid)
+```
+
+## API Reference
+
+### TaskWarrior
+
+The main class for interacting with TaskWarrior.
+
+```python
+from taskwarrior import TaskWarrior
+
+# With defaults (uses ~/.taskrc)
+tw = TaskWarrior()
+
+# With custom configuration
+tw = TaskWarrior(
+    taskrc_file="/path/to/.taskrc",
+    data_location="/path/to/task/data",
+    task_cmd="task"  # Path to task binary
+)
+```
+
+#### Task Operations
+
+| Method | Description |
+|--------|-------------|
+| `add_task(task: TaskInputDTO)` | Create a new task |
+| `get_task(uuid)` | Get a single task by UUID or ID |
+| `get_tasks(filter_args="")` | Get tasks matching filter |
+| `modify_task(task: TaskInputDTO, uuid)` | Modify an existing task |
+| `delete_task(uuid)` | Mark task as deleted |
+| `purge_task(uuid)` | Permanently remove task |
+| `done_task(uuid)` | Mark task as completed |
+| `start_task(uuid)` | Start working on task |
+| `stop_task(uuid)` | Stop working on task |
+| `annotate_task(uuid, annotation)` | Add annotation to task |
+
+#### Context Operations
+
+| Method | Description |
+|--------|-------------|
+| `define_context(name, filter)` | Create a context with filter |
+| `apply_context(name)` | Activate a context |
+| `unset_context()` | Deactivate current context |
+| `get_contexts()` | List all contexts |
+| `get_current_context()` | Get active context name |
+| `delete_context(name)` | Remove a context |
+| `has_context(name)` | Check if context exists |
+
+### Data Models
+
+#### TaskInputDTO
+
+Used for creating and modifying tasks.
+
+```python
+from taskwarrior import TaskInputDTO, Priority, RecurrencePeriod
+
+task = TaskInputDTO(
+    description="Task description",      # Required
+    priority=Priority.HIGH,              # H, M, L or None
+    project="project.subproject",
+    tags=["tag1", "tag2"],
+    due="2024-12-31",                    # ISO date or TW expression
+    scheduled="monday",
+    wait="tomorrow",
+    until="2025-01-01",
+    recur=RecurrencePeriod.WEEKLY,       # daily, weekly, monthly, yearly
+    depends=[uuid1, uuid2],              # Task dependencies
+)
+```
+
+#### TaskOutputDTO
+
+Returned when retrieving tasks. Includes all input fields plus:
+
+```python
+task = tw.get_task(uuid)
+
+task.uuid        # Task UUID
+task.index       # Task ID number
+task.status      # TaskStatus.PENDING, COMPLETED, DELETED, etc.
+task.entry       # Creation datetime
+task.modified    # Last modification datetime
+task.urgency     # Calculated urgency score
+task.annotations # List of annotations
+```
+
+### Enums
+
+```python
+from taskwarrior import Priority, TaskStatus, RecurrencePeriod
+
+# Priority levels
+Priority.HIGH    # "H"
+Priority.MEDIUM  # "M"
+Priority.LOW     # "L"
+
+# Task statuses
+TaskStatus.PENDING
+TaskStatus.COMPLETED
+TaskStatus.DELETED
+TaskStatus.WAITING
+TaskStatus.RECURRING
+
+# Recurrence periods
+RecurrencePeriod.DAILY
+RecurrencePeriod.WEEKLY
+RecurrencePeriod.MONTHLY
+RecurrencePeriod.YEARLY
+```
+
+> **Custom recurrence periods**: TaskWarrior supports any recurrence expression beyond the enum values. Pass a raw string directly to `recur` for periods like `"2weeks"`, `"10days"`, or `"6months"`:
+> ```python
+> task = TaskInputDTO(description="Bi-weekly review", recur="2weeks", due="monday")
+> ```
+
+## Advanced Examples
+
+### Working with Contexts
+
+```python
+# Define contexts for different workflows
+tw.define_context("work", "project:work or +urgent")
+tw.define_context("home", "project:home or project:personal")
+
+# Switch to work context
+tw.apply_context("work")
+
+# Now get_tasks() only returns work-related tasks
+work_tasks = tw.get_tasks()
+
+# Switch back to no context
+tw.unset_context()
+```
+
+### Recurring Tasks
+
+```python
+from taskwarrior import TaskInputDTO, RecurrencePeriod
+
+# Create a weekly recurring task
+weekly_review = TaskInputDTO(
+    description="Weekly project review",
+    due="monday",
+    recur=RecurrencePeriod.WEEKLY,
+    project="reviews",
+)
+tw.add_task(weekly_review)
+
+# Get the parent recurring task
+recurring = tw.get_recurring_task(task.uuid)
+
+# Get all instances
+instances = tw.get_recurring_instances(task.uuid)
+```
+
+### Task Annotations
+
+```python
+# Add notes to a task
+task = tw.add_task(TaskInputDTO(description="Research topic"))
+
+tw.annotate_task(task.uuid, "Found useful article at example.com")
+tw.annotate_task(task.uuid, "Discussed with team, need more info")
+
+# Annotations are included when retrieving tasks
+task = tw.get_task(task.uuid)
+for ann in task.annotations:
+    print(f"{ann.entry}: {ann.description}")
+```
+
+### Date Calculations
+
+```python
+# Use TaskWarrior's date calculation
+result = tw.task_calc("today + 2weeks")
+print(result)  # "2024-02-14T00:00:00"
+
+# Validate a date expression
+if tw.date_validator("next monday"):
+    print("Valid date expression")
+```
+
+## Configuration
+
+### Environment Variables
+
+- `TASKRC` - Path to taskrc file (default: `~/.taskrc`)
+- `TASKDATA` - Path to task data directory
+
+### Automatic Configuration
+
+If no `.taskrc` exists at the specified path, pytaskwarrior creates one with sensible defaults:
+
+```ini
+# Auto-generated by pytaskwarrior
+rc.data.location=~/.task
+rc.confirmation=off
+rc.bulk=0
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/sznicolas/pytaskwarrior.git
+cd pytaskwarrior
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# With coverage
+pytest --cov=src/taskwarrior --cov-report=term-missing
+
+# Run specific test file
+pytest tests/unit/test_dto.py -v
+```
+
+### Code Quality
+
+```bash
+# Linting and formatting
+ruff check src/ tests/
+ruff format src/ tests/
+
+# Type checking
+mypy src/taskwarrior
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Links
+
+- [TaskWarrior](https://taskwarrior.org/) - The underlying task management tool
+- [GitHub Repository](https://github.com/sznicolas/pytaskwarrior/)
+- [PyPI Package](https://pypi.org/project/pytaskwarrior/)
+

pytaskwarrior-1.0.0/pyproject.toml

@@ -0,0 +1,96 @@
+[project]
+name = "pytaskwarrior"
+version = "1.0.0"
+description = "Taskwarrior wrapper python module"
+readme = "PYPI_README.md"
+requires-python = ">=3.12"
+license = "MIT"
+keywords = [ "taskwarrior", "task", "productivity", "cli" ]
+authors = [
+    { name = "sznicolas", email = "sznicolas@users.noreply.github.com" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+    "Typing :: Typed",
+]
+dependencies = [
+    "pydantic>=2.11.7",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.0",
+    "ruff>=0.8.0",
+    "mypy>=1.13.0",
+    "pytest-cov>=7.0.0",
+]
+docs = [
+    "mkdocs>=1.6.0",
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.27.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/sznicolas/pytaskwarrior/"
+Repository = "https://github.com/sznicolas/pytaskwarrior/"
+Issues = "https://github.com/sznicolas/pytaskwarrior/issues"
+Changelog = "https://github.com/sznicolas/pytaskwarrior/blob/main/CHANGELOG.md"
+
+[tool.setuptools.package-data]
+taskwarrior = ["py.typed"]
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+# Target Python 3.12+
+target-version = "py312"
+line-length = 100
+
+[tool.ruff.lint]
+# Enable recommended rules + additional quality checks
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "N",   # pep8-naming
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "SIM", # flake8-simplify
+]
+ignore = [
+    "E501",  # Line too long (handled by formatter)
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = [
+    "N802",    # Function name should be lowercase (allow test_* methods)
+    "SIM117",  # Nested `with` statements in tests (patch + pytest.raises idiom)
+]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_any_unimported = false
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+check_untyped_defs = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false

pytaskwarrior-1.0.0/src/pytaskwarrior.egg-info/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: pytaskwarrior
+Version: 1.0.0
+Summary: Taskwarrior wrapper python module
+Author-email: sznicolas <sznicolas@users.noreply.github.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sznicolas/pytaskwarrior/
+Project-URL: Repository, https://github.com/sznicolas/pytaskwarrior/
+Project-URL: Issues, https://github.com/sznicolas/pytaskwarrior/issues
+Project-URL: Changelog, https://github.com/sznicolas/pytaskwarrior/blob/main/CHANGELOG.md
+Keywords: taskwarrior,task,productivity,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.11.7
+Dynamic: license-file
+
+# pytaskwarrior
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Tests](https://github.com/sznicolas/pytaskwarrior/workflows/CI/badge.svg)](https://github.com/sznicolas/pytaskwarrior/actions)
+[![Coverage](https://img.shields.io/badge/coverage-96%25-brightgreen.svg)](https://github.com/sznicolas/pytaskwarrior)
+[![PyPI version](https://img.shields.io/pypi/v/pytaskwarrior.svg)](https://pypi.org/project/pytaskwarrior/)
+
+A modern Python wrapper for [TaskWarrior](https://taskwarrior.org/), the command-line task management tool.
+
+**v1.0.0**: Production-ready with 132 tests (96% coverage), strict type checking, and professional-grade code quality. Zero linting errors, full async-safe subprocess handling, and PEP 561 type hints for IDE support.
+
+## Features
+
+- ✅ Full CRUD operations for tasks
+- ✅ Type-safe with Pydantic models
+- ✅ Context management
+- ✅ UDA (User Defined Attributes) support
+- ✅ Recurring tasks and annotations
+
+## Requirements
+
+- Python 3.12+
+- TaskWarrior 3.4+ installed
+
+## Installation
+
+```bash
+pip install pytaskwarrior
+```
+
+## Quick Start
+
+```python
+from taskwarrior import TaskWarrior, TaskInputDTO, Priority
+
+tw = TaskWarrior()
+
+# Create a task
+task = TaskInputDTO(
+    description="Important meeting",
+    priority=Priority.HIGH,
+    project="work",
+    due="friday"
+)
+added = tw.add_task(task)
+
+# Get all pending tasks
+for t in tw.get_tasks():
+    print(f"[{t.priority or '-'}] {t.description}")
+
+# Complete a task
+tw.done_task(added.uuid)
+```
+
+## Documentation
+
+Full documentation: [GitHub Repository](https://github.com/sznicolas/pytaskwarrior/)

pytaskwarrior-1.0.0/src/pytaskwarrior.egg-info/SOURCES.txt

@@ -0,0 +1,30 @@
+LICENSE
+PYPI_README.md
+README.md
+pyproject.toml
+src/__init__.py
+src/pytaskwarrior.egg-info/PKG-INFO
+src/pytaskwarrior.egg-info/SOURCES.txt
+src/pytaskwarrior.egg-info/dependency_links.txt
+src/pytaskwarrior.egg-info/requires.txt
+src/pytaskwarrior.egg-info/top_level.txt
+src/taskwarrior/__init__.py
+src/taskwarrior/enums.py
+src/taskwarrior/exceptions.py
+src/taskwarrior/main.py
+src/taskwarrior/py.typed
+src/taskwarrior/adapters/__init__.py
+src/taskwarrior/adapters/taskwarrior_adapter.py
+src/taskwarrior/dto/__init__.py
+src/taskwarrior/dto/annotation_dto.py
+src/taskwarrior/dto/context_dto.py
+src/taskwarrior/dto/task_dto.py
+src/taskwarrior/dto/uda_dto.py
+src/taskwarrior/registry/__init__.py
+src/taskwarrior/registry/uda_registry.py
+src/taskwarrior/services/__init__.py
+src/taskwarrior/services/context_service.py
+src/taskwarrior/services/uda_service.py
+src/taskwarrior/utils/__init__.py
+src/taskwarrior/utils/conversions.py
+src/taskwarrior/utils/dto_converter.py

{pytaskwarrior-0.4.3 → pytaskwarrior-1.0.0}/src/pytaskwarrior.egg-info/requires.txt

@@ -1,2 +1 @@
-isodate>=0.7.2
 pydantic>=2.11.7