pymultirole-plugins
The plugin contracts of the Sherpa multirole family: the Document schema and the
annotator, processor, converter, segmenter and formatter base classes that every
pyannotators_*, pyprocessors_*, pyconverters_*, pysegmenters_* and
pyformatters_* repository builds on.
Installation
pip install pymultirole-plugins
Development
The build is driven by Task and uv,
with the shared stages coming from the python-archetype submodule.
Getting started
The stages live in a Git submodule, so clone with --recurse-submodules:
git clone --recurse-submodules git@bitbucket.org:kairntech/pymultirole_plugins.git
cd pymultirole_plugins
sh -c "$(curl -sSL https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
task
Already cloned without it? The submodule directory is empty, and task fails on:
task: No Taskfile found at ".../submodules/python-archetype/resources/Taskfile.yml"
which means exactly that, and nothing worse:
git submodule update --init
Task is the only manual prerequisite. An archetype cannot bootstrap itself: uv and the
Python interpreter install themselves on demand (every task that runs uv depends on an
internal install-python task), but the thing that runs them does not. Make sure
~/.local/bin is on your PATH — that is where task and uv both land.
Running the pipeline
task stages # print the pipeline stages, in order
task # run the pipeline up to (but excluding) py:publish
task -- --skip-tests # same, without the test stage
task up-to -- py:lint # run the pipeline up to and including one stage
task jenkins # run every stage, exactly what Jenkins runs
task with no argument is safe by construction: it runs every stage but the last, and that
bound is computed from the STAGES list rather than written down. The last stage is the
only one with an effect outside your machine.
STAGES, declared once in Taskfile.yml, is the single definition of the pipeline order —
so what you run locally is what Jenkins runs.
Individual stages
| Task | Description |
|---|---|
task py:sync |
Install the project and its dependencies (uv sync) |
task py:lint |
ruff check and ruff format --check |
task py:format |
Reformat the code with ruff |
task py:test |
Run the test suite |
task py:test-marker -- <m> |
Run the tests carrying one pytest marker |
task py:sbom |
Generate a CycloneDX SBOM of the resolved environment |
task py:check-vulnerabilities |
Check for known CVEs |
task py:check-updates |
Check for dependency updates |
task py:build |
Build the wheel and sdist (uv build) |
task py:publish |
Publish the distributions (uv publish) |
task py:version-file |
Print the path of the file carrying __version__ |
task py:set-version VERSION=x |
Write that version into it |
uv.lock is not versioned here, so py:sync always resolves from scratch (--upgrade):
a stale lock lying around on a machine would otherwise make you test and audit versions the
CI never sees.
SBOM & vulnerability check
task py:sbom and task py:check-vulnerabilities wrap the underlying tools. To run them
by hand:
uv sync --extra test --extra sbom
uv run cyclonedx-py environment -o sbom.cdx.json --output-format json
uv run pip-audit --skip-editable --format json --output audit-report.json
Ask for all the extras, not just sbom: uv sync synchronises rather than adds, so
whatever the requested extras do not pull in gets removed. --extra sbom on its own
uninstalls ruff, pytest-cov and dirty-equals, leaving an environment that can no
longer lint or measure coverage.
--skip-editable skips the project itself, which no advisory database can know about. The
tasks do the same, and pip-audit still exits non-zero when it finds a real vulnerability —
which is the contract the CI relies on. Avoid --strict: it turns "dependency not found on
PyPI" into a fatal error, so it breaks as soon as the local version is not a published one.
Documentation
uv run --extra docs sphinx-build docs docs/_build
Release files for pymultirole-plugins 1.6.686
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pymultirole_plugins-1.6.686.tar.gz | 43.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pymultirole_plugins-1.6.686-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 52.6 kB
Release files / pymultirole_plugins-1.6.686.tar.gz
| Download URL | pymultirole_plugins-1.6.686.tar.gz |
|---|---|
| Size | 43.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
599acda8a73be57d5fbb543e57e92bc459d22cf4a67b0281465ffe76aca0cee3
|
|
BLAKE2b-256 checksum How to use checksums |
0b38f671dae36675897d3a7f88fb402b4ced34f7299618442246a6abdebcd609
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / pymultirole_plugins-1.6.686-py3-none-any.whl
| Download URL | pymultirole_plugins-1.6.686-py3-none-any.whl |
|---|---|
| Size | 8.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1727607f33e374e7f0b4fc8cfdc06bbf905d121e5457f4f80c8de41b74e54721
|
|
BLAKE2b-256 checksum How to use checksums |
dc753a7b8cf6944f5812ec252057e0b9af27d5d2c7704a37ed48b03756ee390c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
