Installation#
Published package#
Use a virtual environment and install from PyPI:
python -m pip install pain001
pain001 --version
Python 3.10 or newer is required. Linux CI tests 3.10–3.14. No Conda default channel package, native binary, or distro-system-Python compatibility is claimed.
Optional integrations#
Install the extra for the integration you need, for example:
python -m pip install 'pain001[api]'
pain001 serve --host 127.0.0.1 --port 8000
Other extras are declared in pyproject.toml. Development and documentation dependencies are Poetry groups, not pip extras named dev, docs or all. Version 0.0.71 adds the rules and upload extras. Until that release is published, use the source checkout below for those additions.
Development checkout#
git clone --branch feat/v0.0.71 https://github.com/sebastienrousseau/pain001.git
cd pain001
poetry install --all-extras --with dev,docs
poetry run make check
poetry run make type
Use Python 3.12 for development. See Development for the native gates and Toolchain and contribution policies for the minimum-toolchain policy.
Containers#
The published core image is ghcr.io/sebastienrousseau/pain001:latest. It runs as a non-root user and includes the API extra. Bind a writable directory when generating files; the CLI output flag names a directory. Development mockbank images are separate synthetic test services, not a production bank or a core release.
Verification and troubleshooting#
python -c 'import pain001; print(pain001.__version__)'
pain001 versions
pain001 generate --help
For environment mismatches inspect poetry env info in a source checkout. Install optional dependencies only for the surfaces you use; missing-extra diagnostics name the required extra.