taskdog-client
HTTP API client library for Taskdog server.
Overview
This package provides a type-safe HTTP client for communicating with the Taskdog API server. It handles authentication, error mapping, and response conversion to domain DTOs.
Use cases:
- Building custom CLI tools
- Integrating Taskdog with other systems
- Creating automated workflows
- Testing API endpoints
Installation
pip install taskdog-client
For development:
pip install -e ".[dev]"
Client Classes
| Client | Purpose |
|---|---|
TaskClient |
Task CRUD operations (create, update, delete, archive) |
LifecycleClient |
Status changes (start, complete, pause, cancel, reopen) |
RelationshipClient |
Dependencies and tags |
QueryClient |
List tasks, get task details |
AnalyticsClient |
Statistics and Gantt data |
NotesClient |
Task notes (markdown) |
AuditClient |
Audit log access |
BaseApiClient |
Base class with common HTTP logic |
Usage Example
from taskdog_client import TaskClient, LifecycleClient, QueryClient
# Create clients
base_url = "http://127.0.0.1:8000"
api_key = "your-api-key" # Optional, for authenticated servers
task_client = TaskClient(base_url, api_key)
lifecycle_client = LifecycleClient(base_url, api_key)
query_client = QueryClient(base_url, api_key)
# Create a task
task = task_client.create_task(
name="My Task",
priority=100,
estimated_duration=8.0,
tags=["backend"]
)
print(f"Created task: {task.id}")
# List tasks
tasks = query_client.list_tasks(status="pending")
for t in tasks:
print(f"- {t.name} (ID: {t.id})")
# Start a task
lifecycle_client.start_task(task.id)
# Complete a task
lifecycle_client.complete_task(task.id)
Error Handling
Clients raise exceptions from taskdog_core.domain.exceptions:
from taskdog_core.domain.exceptions import TaskNotFoundException, TaskValidationError
try:
task_client.get_task(999)
except TaskNotFoundException:
print("Task not found")
except TaskValidationError as e:
print(f"Validation error: {e}")
Configuration
Clients accept optional configuration:
from taskdog_client import TaskClient
# Basic usage (no auth)
client = TaskClient("http://127.0.0.1:8000")
# With API key authentication
client = TaskClient(
base_url="http://127.0.0.1:8000",
api_key="your-secret-key"
)
# Custom timeout (in seconds)
client = TaskClient(
base_url="http://127.0.0.1:8000",
timeout=30.0
)
Dependencies
taskdog-core: Domain DTOs and exceptionshttpx: HTTP client library
Related Packages
- taskdog-core: Domain DTOs used by this package
- taskdog-server: API server this client connects to
- taskdog-ui: CLI/TUI that uses this client
- taskdog-mcp: MCP server that uses this client
Testing
pytest tests/
License
MIT
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
taskdog_client-0.24.0.tar.gz
(35.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file taskdog_client-0.24.0.tar.gz.
File metadata
- Download URL: taskdog_client-0.24.0.tar.gz
- Upload date:
- Size: 35.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5b57be7bcde9c36a3c0933ae757cf639a66513905bc4845f829be28360995e1e
|
|
| MD5 |
df8f07cec88a30b952fb658bc8a4fa62
|
|
| BLAKE2b-256 |
6fe430b469e69d552d6cbbb74450e9a19f4f5cfee57cc9af1f2dcbc8f4997c77
|
Provenance
The following attestation bundles were made for taskdog_client-0.24.0.tar.gz:
Publisher:
release.yml on Kohei-Wada/taskdog
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
taskdog_client-0.24.0.tar.gz -
Subject digest:
5b57be7bcde9c36a3c0933ae757cf639a66513905bc4845f829be28360995e1e - Sigstore transparency entry: 2168909992
- Sigstore integration time:
-
Permalink:
Kohei-Wada/taskdog@9ef1de809661cfac8b2370e08796b87dde50b040 -
Branch / Tag:
refs/tags/v0.24.0 - Owner: https://github.com/Kohei-Wada
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@9ef1de809661cfac8b2370e08796b87dde50b040 -
Trigger Event:
push
-
Statement type:
File details
Details for the file taskdog_client-0.24.0-py3-none-any.whl.
File metadata
- Download URL: taskdog_client-0.24.0-py3-none-any.whl
- Upload date:
- Size: 31.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
403b747dd30df374c337be87de08f5af165de17239f1123407419453c13466cf
|
|
| MD5 |
71ebe3c8ba6ae3a3871e00efe4646274
|
|
| BLAKE2b-256 |
d04d6cee71ef3b250738914e406084e0755186d230891c0ff613ac7efacf0327
|
Provenance
The following attestation bundles were made for taskdog_client-0.24.0-py3-none-any.whl:
Publisher:
release.yml on Kohei-Wada/taskdog
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
taskdog_client-0.24.0-py3-none-any.whl -
Subject digest:
403b747dd30df374c337be87de08f5af165de17239f1123407419453c13466cf - Sigstore transparency entry: 2168910013
- Sigstore integration time:
-
Permalink:
Kohei-Wada/taskdog@9ef1de809661cfac8b2370e08796b87dde50b040 -
Branch / Tag:
refs/tags/v0.24.0 - Owner: https://github.com/Kohei-Wada
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@9ef1de809661cfac8b2370e08796b87dde50b040 -
Trigger Event:
push
-
Statement type:
