smallage 0.2.0__tar.gz

smallage-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - uses: astral-sh/setup-uv@v4
+      - run: uv sync --frozen
+      - name: uv lock is current
+        run: uv lock --check
+      - name: Ruff check
+        run: uv run ruff check .
+      - name: Ruff format
+        run: uv run ruff format --check .
+      - name: Mypy
+        run: uv run mypy
+      - name: Import contracts
+        run: uv run lint-imports
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # The library claims Redis 7 and up; each claimed major gets a run.
+        redis: ["redis:7-alpine", "redis:8-alpine"]
+    env:
+      REDIS_IMAGE: ${{ matrix.redis }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - uses: astral-sh/setup-uv@v4
+      - run: uv sync --frozen
+      - name: Pytest
+        run: uv run pytest -m "unit or integration" --cov --cov-report=term-missing
+
+  build-docs:
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - uses: astral-sh/setup-uv@v4
+      - run: uv sync --frozen
+      - name: Build MkDocs
+        run: uv run mkdocs build --strict
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy-pages:
+    runs-on: ubuntu-latest
+    needs: build-docs
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

smallage-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,74 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Ruff check
+        run: uv run ruff check .
+
+      - name: Ruff format
+        run: uv run ruff format --check .
+
+      - name: Mypy
+        run: uv run mypy src/
+
+      - name: Pytest
+        run: uv run pytest -m unit
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      id-token: write
+    environment: pypi
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

smallage-0.2.0/.gitignore

@@ -0,0 +1,212 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# MacOS
+
+.DS_Store
+.python-version

smallage-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+# See https://pre-commit.com for more information
+repos:
+  - repo: local
+    hooks:
+      - id: ruff
+        name: ruff
+        entry: uv run ruff check
+        language: system
+        types: [python]
+
+      - id: ruff-format
+        name: ruff-format
+        entry: uv run ruff format
+        language: system
+        types: [python]
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: uv run mypy
+        language: system
+        pass_filenames: false
+
+      - id: lint-imports
+        name: import-linter
+        entry: uv run lint-imports
+        language: system
+        pass_filenames: false
+
+      - id: uv-lock-check
+        name: uv lock --check
+        entry: uv lock --check
+        language: system
+        pass_filenames: false
+
+      - id: pytest
+        name: pytest (unit)
+        entry: uv run pytest -m unit
+        language: system
+        pass_filenames: false
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: mixed-line-ending
+      - id: check-added-large-files
+        args: ["--maxkb=1000"]

smallage-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Maksim Smirnov
+
+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.

smallage-0.2.0/Makefile

@@ -0,0 +1,35 @@
+.DEFAULT_GOAL := check
+
+install:
+	uv sync
+	uv run pre-commit install
+
+lint:
+	uv run ruff check .
+	uv run ruff format --check .
+
+format:
+	uv run ruff format .
+	uv run ruff check --fix .
+
+typecheck:
+	uv run mypy
+
+imports:
+	uv run lint-imports
+
+test:
+	uv run pytest -m unit
+
+test-int:
+	uv run pytest -m integration
+
+cov:
+	uv run pytest --cov --cov-report=term-missing
+
+docs:
+	uv run mkdocs build --strict
+
+check: lint typecheck imports test
+
+.PHONY: install lint format typecheck imports test test-int cov docs check

smallage-0.2.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.5
+Name: smallage
+Version: 0.2.0
+Summary: Background tasks, cron and a dead letter queue on Redis Streams, with a Litestar integration
+Project-URL: Homepage, https://github.com/smirnoffmg/smallage
+Project-URL: Documentation, https://smirnoffmg.dev/smallage/
+Project-URL: Source, https://github.com/smirnoffmg/smallage
+Project-URL: Issues, https://github.com/smirnoffmg/smallage/issues
+Author: Maksim Smirnov
+License-Expression: MIT
+License-File: LICENSE
+Keywords: background-tasks,celery,cron,dead-letter-queue,dlq,faststream,litestar,redis,redis-streams,streams,task-queue
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AnyIO
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: anyio>=4.2
+Requires-Dist: cronsim>=2.7
+Requires-Dist: litestar>=2.0
+Requires-Dist: msgspec>=0.18
+Requires-Dist: redis[hiredis]>=5.0
+Requires-Dist: uvloop>=0.21
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/smirnoffmg/smallage/main/docs/assets/logo.png"
+       alt="smallage — wild celery (Apium graveolens)" width="180">
+</p>
+
+# smallage
+
+[![PyPI version](https://img.shields.io/pypi/v/smallage)](https://pypi.org/project/smallage/)
+[![Python versions](https://img.shields.io/pypi/pyversions/smallage)](https://pypi.org/project/smallage/)
+[![License](https://img.shields.io/pypi/l/smallage)](https://pypi.org/project/smallage/)
+[![CI](https://img.shields.io/github/actions/workflow/status/smirnoffmg/smallage/ci.yml?branch=main)](https://github.com/smirnoffmg/smallage/actions/workflows/ci.yml)
+[![Checked with mypy](https://img.shields.io/badge/mypy-strict-2a6db2)](https://mypy-lang.org/)
+
+Background tasks, cron and a dead letter queue on Redis Streams — typed tasks,
+retries with backoff, delayed jobs, and consumption of streams somebody else
+writes. The core reaches for no web framework; the
+[Litestar](https://litestar.dev/) layer adds real dependency injection and a CLI
+through the native plugin protocol.
+
+*Smallage is the old name for wild celery.*
+
+📖 **[Documentation](https://smirnoffmg.dev/smallage/)**
+
+## Features
+
+- Tasks are ordinary functions: arguments are serialised, dependencies injected
+- Retries with backoff, a delivery ceiling, and a dead letter queue that keeps
+  the payload, the traceback and the attempt history
+- Delayed jobs and cron with no scheduler process, correct across DST
+- Priority queues with a bounded starvation window, and shards for fairness
+- Broker mode: consume streams somebody else writes, in the same worker
+- Optional results, a deduplication gate, and trace context carried into the task
+- Health endpoint served identically by the web process and the worker
+- Eager mode, `assert_enqueued` and a real-worker fixture for your own tests
+
+## Installation
+
+```bash
+uv add smallage
+```
+
+Redis 7 or newer. Standalone, Sentinel and Cluster are all covered by the test
+suite.
+
+## Quick start
+
+```python
+from dataclasses import dataclass
+from uuid import UUID, uuid4
+
+from litestar import Litestar, post
+from litestar.di import Provide
+
+from smallage.litestar import QueueConfig, QueuePlugin, TaskRegistry
+
+tasks = TaskRegistry()
+
+
+@dataclass
+class Settings:
+    index_name: str = "documents"
+
+
+def settings() -> Settings:
+    return Settings()
+
+
+@tasks.task
+async def reindex(doc_id: UUID, settings: Settings) -> None:
+    """`doc_id` is serialised; `settings` comes from the application."""
+
+
+@post("/documents")
+async def create() -> str:
+    await reindex.enqueue(doc_id=uuid4())
+    return "queued"
+
+
+app = Litestar(
+    route_handlers=[create],
+    dependencies={"settings": Provide(settings, sync_to_thread=False)},
+    plugins=[QueuePlugin(QueueConfig(registry=tasks, redis_url="redis://localhost"))],
+)
+```
+
+`doc_id` travels in the payload; `settings` is injected in the worker from the
+application's own dependency graph, and a real one would be a database session
+or a client. There is no context dictionary.
+
+## Workers
+
+A worker is the same application, started differently:
+
+```bash
+litestar workers run --queue high --concurrency 20
+```
+
+The lifecycle comes with it: a worker enters the application's lifespan, so
+`on_startup` hooks and lifespan managers run there too and a dependency closing
+over what they opened is usable in a task. `run_app_lifespan=False` declines
+that, for a lifespan whose work belongs to a web process alone.
+
+Anything that can be settled at startup is — a task registered twice, an
+argument with no annotation, a dependency the application does not provide, a
+cycle, a provider only a request could satisfy — rather than on the first job in
+production.
+
+## Delivery guarantee
+
+**At-least-once.** A worker that completed its side effect and died before
+`XACK` will be reclaimed and the work repeated. No amount of protocol work
+removes that; only an idempotent handler does. A `dedup` key is provided for the
+cases where that is not naturally true.
+
+## Documentation
+
+Tasks, scheduling, retries, priorities, broker mode, results, testing and
+operations are covered in the
+**[full documentation](https://smirnoffmg.dev/smallage/)**. The rules the
+library is built to are in
+**[Design and invariants](https://smirnoffmg.dev/smallage/design/)**.
+Runnable [examples](examples/) are included.
+
+## Development
+
+```bash
+make install   # dependencies and git hooks
+make check     # lint, types, import contracts, unit tests
+make test-int  # integration suite, needs Docker
+```
+
+## License
+
+MIT