pydocket 0.6.3__tar.gz → 0.15.3__tar.gz

pydocket-0.15.3/.coveragerc-memory

@@ -0,0 +1,11 @@
+# Coverage configuration for memory backend testing
+# CLI tests are skipped with memory:// URLs, so exclude CLI from coverage
+
+[run]
+branch = true
+parallel = true
+omit =
+    src/docket/__main__.py
+    src/docket/_uuid7.py
+    src/docket/cli.py
+    tests/cli/test_*.py

{pydocket-0.6.3 → pydocket-0.15.3}/.cursor/rules/general.mdc

@@ -6,7 +6,7 @@ alwaysApply: true
 
 # about docket
 docket is a distributed background task system for Python functions with a focus
-on the scheduling of future work as seamlessly and efficiency as immediate work.
+on the scheduling of future work as seamlessly and efficiently as immediate work.
 
 docket is built in Python and uses Redis as the message broker and storage system.
 

{pydocket-0.6.3 → pydocket-0.15.3}/.github/workflows/chaos.yml

@@ -8,13 +8,15 @@ on:
   workflow_call:
 
 jobs:
-  test:
+  chaos:
     name: Chaos tests
     runs-on: ubuntu-latest
     timeout-minutes: 2
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Install uv and set Python version
         uses: astral-sh/setup-uv@v5
@@ -28,3 +30,24 @@ jobs:
 
       - name: Run chaos tests
         run: python -m chaos.driver
+
+  signals:
+    name: Signal handling tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set Python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.12
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run signal handling tests
+        run: python -m chaos.signals

pydocket-0.15.3/.github/workflows/ci.yml

@@ -0,0 +1,100 @@
+name: Docket CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_call:
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}, ${{ matrix.backend.name }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        backend:
+          - name: "Redis 6.2, redis-py <5"
+            redis-version: "6.2"
+            redis-py-version: ">=5,<6"
+          - name: "Redis 7.4, redis-py >=5"
+            redis-version: "7.4"
+            redis-py-version: ">=5"
+          - name: "Redis 8.0, redis-py >=5"
+            redis-version: "8.0"
+            redis-py-version: ">=5"
+          - name: "Valkey 8.0, redis-py >=5"
+            redis-version: "valkey-8.0"
+            redis-py-version: ">=5"
+          - name: "Memory (in-memory backend)"
+            redis-version: "memory"
+            redis-py-version: ">=5"
+        include:
+          - python-version: "3.10"
+            cov-threshold: 100
+            pytest-args: ""
+          # Python 3.11 coverage reporting is unstable, so use 98% threshold
+          - python-version: "3.11"
+            cov-threshold: 98
+            pytest-args: ""
+          - python-version: "3.12"
+            cov-threshold: 100
+            pytest-args: ""
+          - python-version: "3.13"
+            cov-threshold: 100
+            pytest-args: ""
+          - python-version: "3.14"
+            cov-threshold: 100
+            pytest-args: ""
+          # Memory backend: CLI tests are skipped via pytest skip markers because
+          # CLI rejects memory:// URLs. Use separate coverage config to exclude CLI.
+          - backend:
+              name: "Memory (in-memory backend)"
+              redis-version: "memory"
+              redis-py-version: ">=5"
+            cov-threshold: 98 # CLI tests are excluded from coverage and some lines are only covered by CLI tests
+            pytest-args: "--cov-config=.coveragerc-memory"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set Python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Install dependencies
+        run: uv sync --upgrade-package 'redis${{ matrix.backend.redis-py-version }}'
+
+      - name: Run tests
+        env:
+          REDIS_VERSION: ${{ matrix.backend.redis-version }}
+        run: uv run pytest --cov-branch --cov-fail-under=${{ matrix.cov-threshold }} --cov-report=xml --cov-report=term-missing:skip-covered ${{ matrix.pytest-args }}
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: python-${{ matrix.python-version }}
+
+  prek:
+    name: Prek checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set Python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.10"
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run prek
+        uses: j178/prek-action@v1

pydocket-0.15.3/.github/workflows/claude-code-review.yml

@@ -0,0 +1,40 @@
+name: Claude Code Review
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  claude-review:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Run Claude Code Review
+        id: claude-review
+        uses: anthropics/claude-code-action@beta
+        with:
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+          model: "claude-opus-4-1-20250805"
+
+          # Direct prompt for automated review (no @claude mention needed)
+          direct_prompt: |
+            Please review this pull request and provide feedback on:
+            - Code quality and best practices
+            - Potential bugs or issues
+            - Performance considerations
+            - Security concerns
+            - Test coverage, which must be maintained at 100% for this project
+
+            Be constructive and helpful in your feedback.
+
+          use_sticky_comment: true

pydocket-0.15.3/.github/workflows/claude.yml

@@ -0,0 +1,42 @@
+name: Claude Code
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+  issues:
+    types: [opened, assigned]
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  claude:
+    if: |
+      (github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
+      (github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
+      (github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
+      (github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+      actions: read # Required for Claude to read CI results on PRs
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Run Claude Code
+        id: claude
+        uses: anthropics/claude-code-action@beta
+        with:
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+
+          additional_permissions: |
+            actions: read
+
+          model: "claude-opus-4-1-20250805"

pydocket-0.15.3/.github/workflows/docs.yml

@@ -0,0 +1,84 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv and set Python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Install dependencies
+        run: uv sync --group docs
+
+      - name: Build documentation
+        run: uv run mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        id: docs-artifact
+        with:
+          name: documentation
+          path: site/
+
+      - name: Add or Update Comment
+        if: github.event_name == 'pull_request'
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: preview
+          message: |
+            📚 Documentation has been built for this PR!
+
+            You can download the documentation directly here:
+            ${{ steps.docs-artifact.outputs.artifact-url }}
+
+  publish:
+    needs: build
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: documentation
+          path: site
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{pydocket-0.6.3 → pydocket-0.15.3}/.github/workflows/publish.yml

@@ -13,8 +13,11 @@ jobs:
     name: Build and publish to PyPI
     runs-on: ubuntu-latest
     needs: ci
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pydocket
     permissions:
-      id-token: write
+      id-token: write  # Required for trusted publishing and PEP 740 attestations
       contents: read
 
     steps:
@@ -31,10 +34,12 @@ jobs:
           cache-dependency-glob: "pyproject.toml"
 
       - name: Install build dependencies
-        run: uv pip install build hatchling hatch-vcs
+        run: uv pip install hatchling hatch-vcs
 
       - name: Build package
         run: uv build
 
-      - name: Publish to PyPI
-        run: uv publish
+      - name: Publish to PyPI with PEP 740 attestations
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

{pydocket-0.6.3 → pydocket-0.15.3}/.gitignore

@@ -1,13 +1,13 @@
-# Python-generated files
-__pycache__/
+*.egg-info
 *.py[oc]
+.coverage
+.envrc
+.python-version
+.venv
+.worktrees/
+__pycache__/
 build/
 dist/
 wheels/
-*.egg-info
 
-# Virtual environments
-.venv
-.coverage
-.envrc
-.python-version
+.coverage.*

{pydocket-0.6.3 → pydocket-0.15.3}/.pre-commit-config.yaml

@@ -24,13 +24,19 @@ repos:
     hooks:
       - id: pyright
         name: pyright (docket package)
-        entry: pyright --verifytypes docket --ignoreexternal
+        entry: uv run pyright --verifytypes docket --ignoreexternal
         language: system
         types: [python]
         pass_filenames: false
       - id: pyright
         name: pyright (source and tests)
-        entry: pyright tests
+        entry: uv run pyright tests
+        language: system
+        types: [python]
+        pass_filenames: false
+      - id: pyright
+        name: pyright (chaos tests)
+        entry: uv run pyright chaos
         language: system
         types: [python]
         pass_filenames: false

pydocket-0.15.3/CLAUDE.md

@@ -0,0 +1,125 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+**Docket** (`pydocket` on PyPI) is a distributed background task system for Python functions with Redis-backed persistence. It enables scheduling both immediate and future work with comprehensive dependency injection, retry mechanisms, and fault tolerance.
+
+**Key Requirements**: Python 3.10+, Redis 6.2+ or Valkey 8.0+
+
+## Development Commands
+
+### Testing
+
+```bash
+# Run full test suite with coverage and parallel execution
+pytest
+
+# Run specific test
+pytest tests/test_docket.py::test_specific_function
+
+```
+
+The project REQUIRES 100% test coverage
+
+### Code Quality
+
+```bash
+# Lint and format code
+ruff check
+ruff format
+
+# Type checking
+pyright
+pyright tests
+
+# Run all prek hooks
+uv run prek run --all-files
+```
+
+### Development Setup
+
+```bash
+# Install development dependencies
+uv sync --group dev
+
+# Install prek hooks
+uv run prek install
+```
+
+### Git Workflow
+
+- This project uses Github for issue tracking
+- This project can use git worktrees under .worktrees/
+
+## Core Architecture
+
+### Key Classes
+
+- **`Docket`** (`src/docket/docket.py`): Central task registry and scheduler
+  - `add()`: Schedule tasks for execution
+  - `replace()`: Replace existing scheduled tasks
+  - `cancel()`: Cancel pending tasks
+  - `strike()`/`restore()`: Conditionally block/unblock tasks
+  - `snapshot()`: Get current state for observability
+
+- **`Worker`** (`src/docket/worker.py`): Task execution engine
+  - `run_forever()`/`run_until_finished()`: Main execution loops
+  - Handles concurrency, retries, and dependency injection
+  - Maintains heartbeat for liveness tracking
+
+- **`Execution`** (`src/docket/execution.py`): Task execution context with metadata
+
+### Dependencies System (`src/docket/dependencies.py`)
+
+Rich dependency injection supporting:
+
+- Context access: `CurrentDocket`, `CurrentWorker`, `CurrentExecution`
+- Retry strategies: `Retry`, `ExponentialRetry`
+- Special behaviors: `Perpetual` (self-rescheduling), `Timeout`
+- Custom injection: `Depends()`
+- Contextual logging: `TaskLogger`
+
+### Redis Data Model
+
+- **Streams**: `{docket}:stream` (ready tasks), `{docket}:strikes` (commands)
+- **Sorted Sets**: `{docket}:queue` (scheduled tasks), `{docket}:workers` (heartbeats)
+- **Hashes**: `{docket}:{key}` (parked task data)
+- **Sets**: `{docket}:worker-tasks:{worker}` (worker capabilities)
+
+### Task Lifecycle
+
+1. Registration with `Docket.register()` or `@docket.task`
+2. Scheduling: immediate → Redis stream, future → Redis sorted set
+3. Worker processing: scheduler moves due tasks, workers consume via consumer groups
+4. Execution: dependency injection, retry logic, acknowledgment
+
+## Project Structure
+
+### Source Code
+
+- `src/docket/` - Main package
+  - `__init__.py` - Public API exports
+  - `docket.py` - Core Docket class
+  - `worker.py` - Worker implementation
+  - `execution.py` - Task execution context
+  - `dependencies.py` - Dependency injection system
+  - `tasks.py` - Built-in utility tasks
+  - `cli.py` - Command-line interface
+
+### Testing and Examples
+
+- `tests/` - Comprehensive test suite
+- `examples/` - Usage examples
+- `chaos/` - Chaos testing framework
+
+## CLI Usage
+
+```bash
+# Run a worker
+docket worker --url redis://localhost:6379/0 --tasks your.module --concurrency 4
+
+# See all commands
+docket --help
+```

pydocket-0.15.3/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: pydocket
+Version: 0.15.3
+Summary: A distributed background task system for Python functions
+Project-URL: Homepage, https://github.com/chrisguidry/docket
+Project-URL: Bug Tracker, https://github.com/chrisguidry/docket/issues
+Author-email: Chris Guidry <guid@omg.lol>
+License: # Released under MIT License
+        
+        Copyright (c) 2025 Chris Guidry.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: cloudpickle>=3.1.1
+Requires-Dist: exceptiongroup>=1.2.0; python_version < '3.11'
+Requires-Dist: fakeredis[lua]>=2.32.1
+Requires-Dist: opentelemetry-api>=1.30.0
+Requires-Dist: opentelemetry-exporter-prometheus>=0.51b0
+Requires-Dist: prometheus-client>=0.21.1
+Requires-Dist: py-key-value-aio[memory,redis]>=0.3.0
+Requires-Dist: python-json-logger>=2.0.7
+Requires-Dist: redis>=5
+Requires-Dist: rich>=13.9.4
+Requires-Dist: typer>=0.15.1
+Requires-Dist: typing-extensions>=4.12.0
+Description-Content-Type: text/markdown
+
+Docket is a distributed background task system for Python functions with a focus
+on the scheduling of future work as seamlessly and efficiently as immediate work.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pydocket)](https://pypi.org/project/pydocket/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydocket)](https://pypi.org/project/pydocket/)
+[![GitHub main checks](https://img.shields.io/github/check-runs/chrisguidry/docket/main)](https://github.com/chrisguidry/docket/actions/workflows/ci.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/chrisguidry/docket)](https://app.codecov.io/gh/chrisguidry/docket)
+[![PyPI - License](https://img.shields.io/pypi/l/pydocket)](https://github.com/chrisguidry/docket/blob/main/LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://chrisguidry.github.io/docket/)
+
+## At a glance
+
+```python
+from datetime import datetime, timedelta, timezone
+
+from docket import Docket
+
+
+async def greet(name: str, greeting="Hello") -> None:
+    print(f"{greeting}, {name} at {datetime.now()}!")
+
+
+async with Docket() as docket:
+    await docket.add(greet)("Jane")
+
+    now = datetime.now(timezone.utc)
+    soon = now + timedelta(seconds=3)
+    await docket.add(greet, when=soon)("John", greeting="Howdy")
+```
+
+```python
+from docket import Docket, Worker
+
+async with Docket() as docket:
+    async with Worker(docket) as worker:
+        worker.register(greet)
+        await worker.run_until_finished()
+```
+
+```
+Hello, Jane at 2025-03-05 13:58:21.552644!
+Howdy, John at 2025-03-05 13:58:24.550773!
+```
+
+Check out our docs for more [details](http://chrisguidry.github.io/docket/),
+[examples](https://chrisguidry.github.io/docket/getting-started/), and the [API
+reference](https://chrisguidry.github.io/docket/api-reference/).
+
+## Why `docket`?
+
+⚡️ Snappy one-way background task processing without any bloat
+
+📅 Schedule immediate or future work seamlessly with the same interface
+
+⏭️ Skip problematic tasks or parameters without redeploying
+
+🌊 Purpose-built for Redis streams
+
+🧩 Fully type-complete and type-aware for your background task functions
+
+💉 Dependency injection like FastAPI, Typer, and FastMCP for reusable resources
+
+## Installing `docket`
+
+Docket is [available on PyPI](https://pypi.org/project/pydocket/) under the package name
+`pydocket`. It targets Python 3.10 or above.
+
+With [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+uv pip install pydocket
+
+or
+
+uv add pydocket
+```
+
+With `pip`:
+
+```bash
+pip install pydocket
+```
+
+Docket requires a [Redis](http://redis.io/) server with Streams support (which was
+introduced in Redis 5.0.0). Docket is tested with Redis 6, 7, and 8.
+
+For testing without Redis, Docket includes [fakeredis](https://github.com/cunla/fakeredis-py) for in-memory operation:
+
+```python
+from docket import Docket
+
+async with Docket(name="my-docket", url="memory://my-docket") as docket:
+    # Use docket normally - all operations are in-memory
+    ...
+```
+
+See [Testing with Docket](https://chrisguidry.github.io/docket/testing/#using-in-memory-backend-no-redis-required) for more details.
+
+# Hacking on `docket`
+
+We use [`uv`](https://docs.astral.sh/uv/) for project management, so getting set up
+should be as simple as cloning the repo and running:
+
+```bash
+uv sync
+```
+
+The to run the test suite:
+
+```bash
+pytest
+```
+
+We aim to maintain 100% test coverage, which is required for all PRs to `docket`. We
+believe that `docket` should stay small, simple, understandable, and reliable, and that
+begins with testing all the dusty branches and corners. This will give us the
+confidence to upgrade dependencies quickly and to adapt to new versions of Redis over
+time.