aioq 0.1.0__tar.gz

aioq-0.1.0/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      dev-dependencies:
+        patterns:
+          - "pytest*"
+          - "ruff"
+          - "mypy"
+          - "pre-commit"
+          - "fakeredis"
+          - "httpx"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

aioq-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+
+      - name: Run ruff lint
+        run: uvx ruff check .
+
+      - name: Run ruff format check
+        run: uvx ruff format --check .
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dev dependencies
+        run: uv sync --extra dev
+
+      - name: Run tests
+        run: uv run pytest tests/ -v --cov=src/aioq --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v6
+        if: matrix.python-version == '3.11'
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false

aioq-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+name: Deploy docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Build and deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # full history for git-revision-date plugin
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install docs dependencies
+        run: uv sync --extra docs
+
+      - name: Build and deploy to GitHub Pages
+        run: uv run mkdocs gh-deploy --force

aioq-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,65 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+  id-token: write  # for PyPI trusted publishing
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Create GitHub Release
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          files: dist/*

aioq-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

aioq-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - 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: check-json
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.10
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        args: [--ignore-missing-imports, --explicit-package-bases]
+        additional_dependencies:
+          - pydantic>=2.0
+          - types-redis
+          - types-croniter

aioq-0.1.0/LICENSE

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

aioq-0.1.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: aioq
+Version: 0.1.0
+Summary: Async job queue with multiple backend support and built-in dashboard
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: anyio>=4.0
+Requires-Dist: click>=8.1
+Requires-Dist: fastapi>=0.111
+Requires-Dist: jinja2>=3.1
+Requires-Dist: pydantic>=2.0
+Requires-Dist: redis>=5.0
+Requires-Dist: uvicorn[standard]>=0.30
+Provides-Extra: all
+Requires-Dist: asyncpg>=0.29; extra == 'all'
+Requires-Dist: croniter>=2.0; extra == 'all'
+Provides-Extra: cron
+Requires-Dist: croniter>=2.0; extra == 'cron'
+Provides-Extra: dev
+Requires-Dist: asyncpg>=0.29; extra == 'dev'
+Requires-Dist: croniter>=2.0; extra == 'dev'
+Requires-Dist: fakeredis>=2.23; extra == 'dev'
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs>=1.6; extra == 'docs'
+Requires-Dist: pymdown-extensions>=10.0; extra == 'docs'
+Provides-Extra: postgres
+Requires-Dist: asyncpg>=0.29; extra == 'postgres'
+Description-Content-Type: text/markdown
+
+# aioq
+
+Async job queue for Python with Redis/PostgreSQL backends and a built-in real-time dashboard.
+
+**[Documentation](https://ykus4.github.io/aioq/)** · [PyPI](https://pypi.org/project/aioq/)
+
+## Install
+
+```bash
+pip install aioq           # Redis
+pip install "aioq[all]"    # Redis + PostgreSQL + cron
+```
+
+## Quick start
+
+```python
+from aioq import Aarq
+from aioq.backends import RedisBroker
+
+app = Aarq(broker=RedisBroker())
+
+@app.task(queue="default", retries=3)
+async def send_email(ctx, to: str, subject: str) -> dict:
+    ...
+```
+
+```bash
+aioq worker tasks:app       # run a worker
+aioq dashboard tasks:app    # open the dashboard at :8080
+```
+
+See the **[docs](https://ykus4.github.io/aioq/)** for full usage, backend configuration, and API reference.
+
+## License
+
+MIT

aioq-0.1.0/README.md

@@ -0,0 +1,36 @@
+# aioq
+
+Async job queue for Python with Redis/PostgreSQL backends and a built-in real-time dashboard.
+
+**[Documentation](https://ykus4.github.io/aioq/)** · [PyPI](https://pypi.org/project/aioq/)
+
+## Install
+
+```bash
+pip install aioq           # Redis
+pip install "aioq[all]"    # Redis + PostgreSQL + cron
+```
+
+## Quick start
+
+```python
+from aioq import Aarq
+from aioq.backends import RedisBroker
+
+app = Aarq(broker=RedisBroker())
+
+@app.task(queue="default", retries=3)
+async def send_email(ctx, to: str, subject: str) -> dict:
+    ...
+```
+
+```bash
+aioq worker tasks:app       # run a worker
+aioq dashboard tasks:app    # open the dashboard at :8080
+```
+
+See the **[docs](https://ykus4.github.io/aioq/)** for full usage, backend configuration, and API reference.
+
+## License
+
+MIT

aioq-0.1.0/docs/backends/custom.md

@@ -0,0 +1,138 @@
+# Custom Backend
+
+You can add support for any storage system by subclassing `BaseBroker` and implementing all abstract methods.
+
+## Implementation template
+
+```python
+from aioq.backends.base import BaseBroker
+from aioq.models import Job, JobStatus
+
+
+class MyBroker(BaseBroker):
+
+    # ------------------------------------------------------------------
+    # Lifecycle
+    # ------------------------------------------------------------------
+
+    async def connect(self) -> None:
+        """Open connections / pools."""
+        ...
+
+    async def disconnect(self) -> None:
+        """Close connections / pools."""
+        ...
+
+    # ------------------------------------------------------------------
+    # Job lifecycle
+    # ------------------------------------------------------------------
+
+    async def enqueue(self, job: Job) -> None:
+        """Persist and publish a job."""
+        ...
+
+    async def dequeue(self, queues: list[str], timeout: float = 2.0) -> Job | None:
+        """
+        Block until a job is available on any of `queues`, or until
+        `timeout` seconds elapse. Return None on timeout.
+
+        Must be safe for concurrent workers (only one worker receives each job).
+        """
+        ...
+
+    async def ack(self, job: Job) -> None:
+        """Acknowledge successful completion."""
+        ...
+
+    async def nack(self, job: Job, requeue: bool = False) -> None:
+        """Negative-acknowledge a job. Requeue if `requeue=True`."""
+        ...
+
+    async def update_job(self, job: Job) -> None:
+        """Persist updated job state (status, result, error, etc.)."""
+        ...
+
+    async def get_job(self, job_id: str) -> Job | None:
+        """Fetch a single job by ID."""
+        ...
+
+    async def list_jobs(
+        self,
+        queue: str | None = None,
+        status: JobStatus | None = None,
+        limit: int = 100,
+        offset: int = 0,
+    ) -> list[Job]:
+        """Return jobs filtered by queue/status, ordered by enqueued_at desc."""
+        ...
+
+    async def queue_stats(self) -> dict[str, dict[str, int]]:
+        """
+        Return per-queue status counts.
+        Example: {"default": {"pending": 3, "running": 1, "completed": 42}}
+        """
+        ...
+
+    async def cancel_job(self, job_id: str) -> bool:
+        """
+        Set a pending/retrying job to cancelled.
+        Return True if cancelled, False if the job was in a non-cancellable state.
+        """
+        ...
+
+    async def retry_job(self, job_id: str) -> bool:
+        """
+        Reset a failed/cancelled job to pending and re-enqueue it.
+        Return True if retried, False if the job was in a non-retryable state.
+        """
+        ...
+
+    # ------------------------------------------------------------------
+    # Workers
+    # ------------------------------------------------------------------
+
+    async def register_worker(self, worker_id: str, queues: list[str]) -> None:
+        """Register a worker on startup."""
+        ...
+
+    async def heartbeat_worker(self, worker_id: str) -> None:
+        """Update the worker's last-seen timestamp."""
+        ...
+
+    async def deregister_worker(self, worker_id: str) -> None:
+        """Remove the worker on shutdown."""
+        ...
+
+    async def list_workers(self) -> list[dict]:
+        """
+        Return a list of worker dicts. Each dict must include at minimum:
+          worker_id, queues, registered_at, last_heartbeat, alive
+        """
+        ...
+```
+
+## Registration
+
+Pass your broker to `Aarq` like any other:
+
+```python
+from aioq import Aarq
+
+broker = MyBroker(...)
+app = Aarq(broker=broker)
+```
+
+## Context manager support
+
+`BaseBroker` already implements `__aenter__` / `__aexit__` which call `connect()` and `disconnect()`. You get this for free:
+
+```python
+async with MyBroker(...) as broker:
+    await broker.enqueue(job)
+```
+
+## Tips
+
+- **Dequeue atomicity**: the most important invariant is that `dequeue()` returns a job to at most one worker. Use `SELECT ... FOR UPDATE SKIP LOCKED` (SQL), `BRPOP` (Redis), or an equivalent mechanism.
+- **Timeout**: `dequeue()` should block for at most `timeout` seconds and return `None` if nothing arrives. This lets the worker check `_running` regularly for graceful shutdown.
+- **Worker liveness**: store `last_heartbeat` and expose an `alive` boolean in `list_workers()` (e.g. `alive = last_heartbeat > now - 30s`). The dashboard uses this.