Metadata-Version: 2.3
Name: openaleph-procrastinate
Version: 5.1.2
Summary: Task queue logic for OpenAleph built upon procrastinate
License: AGPLv3+
Author: Simon Wörpel
Author-email: simon.woerpel@pm.me
Requires-Python: >=3.11,<4
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: anystore (>=0.4.0,<0.5.0)
Requires-Dist: cachetools (<6)
Requires-Dist: followthemoney (>=4.3.2,<5.0.0)
Requires-Dist: ftmq (>=4.3.2,<5.0.0)
Requires-Dist: procrastinate (>=3.5.3,<4.0.0)
Requires-Dist: psycopg (>=3.2.11,<4.0.0)
Requires-Dist: pydantic (>=2.11.7,<3.0.0)
Requires-Dist: pydantic-settings (>=2.10.1,<3.0.0)
Project-URL: Documentation, https://github.com/openaleph/openaleph-procrastinate
Project-URL: Homepage, https://github.com/openaleph/openaleph-procrastinate
Project-URL: Issues, https://github.com/openaleph/openaleph-procrastinate/issues
Project-URL: Repository, https://github.com/openaleph/openaleph-procrastinate
Description-Content-Type: text/markdown

[![Python test and package](https://github.com/openaleph/openaleph-procrastinate/actions/workflows/python.yml/badge.svg)](https://github.com/openaleph/openaleph-procrastinate/actions/workflows/python.yml)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Coverage Status](https://coveralls.io/repos/github/openaleph/openaleph-procrastinate/badge.svg?branch=main)](https://coveralls.io/github/openaleph/openaleph-procrastinate?branch=main)
[![AGPLv3+ License](https://img.shields.io/pypi/l/openaleph-procrastinate)](./LICENSE)

# OpenAleph Procrastinate

The most dumbest task queue for [OpenAleph](https://openaleph.org) based on [procrastinate](https://procrastinate.readthedocs.io/en/stable/)

## Documentation

https://openaleph.org/docs/lib/openaleph-procrastinate

## Development

This package is using [poetry](https://python-poetry.org/) for packaging and dependencies management, so first [install it](https://python-poetry.org/docs/#installation).

Clone this repository to a local destination.

Within the repo directory, run

    poetry install --with dev

This installs a few development dependencies, including [pre-commit](https://pre-commit.com/) which needs to be registered:

    poetry run pre-commit install

Before creating a commit, this checks for correct code formatting (isort, black) and some other useful stuff (see: `.pre-commit-config.yaml`)

### requirements.txt

To lock dependencies, we use `poetry lock` and a pre-commit hook that exports the lockfile to `requirements.txt`. Always make sure to check in the lockfile when adding packages.

## License and Copyright

`openaleph-procrastinate`, (C) 2025 [Data and Research Center – DARC](https://dataresearchcenter.org)

`openaleph-procrastinate` is licensed under the AGPLv3 or later license.

see [NOTICE](./NOTICE) and [LICENSE](./LICENSE)

