Skip to main content


AccessionFlow

CI/CD codecov PyPI Documentation Status

Accessioning is the process of formally receiving material from a source and registering it in a managed collection. AccessionFlow is a collection of tools to accession data: collate, label, de-identify and store them in a data store. Support for various file types is provided through the FileFormats package and its extensions (e.g. FileFormats MedImage, FileFormats Siemens,...).

accessionflow overview

Where the files come from and where they go are both plugins: sources provide the collate subcommands (collate folder, collate orthanc), and data stores provide the label, store and check-store subcommands (e.g. label xnat, store folder).

Installation

A Docker image containing the toolkit can be pulled from the GitHub Container Registry and entrypoint of the image is the accessionflow CLI so commands can be run by the form

docker run ghcr.io/australian-imaging-service/accessionflow:latest <command-name> <arg1> <arg2> ... --opt1 <opt1> ...

Alternatively, AccessionFlow can be installed as a Python package from PyPI with pip:

$ python3 -m pip install accessionflow

Running

AccessionFlow has a public API and a command-line interface (CLI), with sub-commands to collate, attach, label, de-identify and store accessions in a data store — either as a one-off run or as a continuously-running service (e.g. via Docker Compose or Kubernetes). For example:

$ accessionflow collate folder /data/incoming /data/staging/collated
$ accessionflow label folder /data/staging/collated /data/staging/labelled --level subject PatientID
$ accessionflow store folder /data/staging/labelled s3://my-bucket/archive

See the full documentation for a hands-on quick start, a guide to each source, stage and data store, and the complete CLI/API reference.

Metadata

Release files for accessionflow 0.20.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for accessionflow 0.20.5
File Size Uploaded Provenance Actions
accessionflow-0.20.5.tar.gz 280.6 kB Without provenance Details for accessionflow-0.20.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for accessionflow 0.20.5
File Interpreter ABI Platform Actions
accessionflow-0.20.5-py3-none-any.whl Python 3 none any Details for accessionflow-0.20.5-py3-none-any.whl

Total release size: 640.9 kB

Release files / accessionflow-0.20.5.tar.gz

Download URL accessionflow-0.20.5.tar.gz
Size 280.6 kB
Tags Source
SHA-256 checksum
How to use checksums
aeba31e69960ee1e4d257dc39945a8a8eb356b21f726e6536711e55e909c2a88
BLAKE2b-256 checksum
How to use checksums
c7b36a1ca02604db16be0f4445a2029243072a0ae50244940436855d62af2c41
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / accessionflow-0.20.5-py3-none-any.whl

Download URL accessionflow-0.20.5-py3-none-any.whl
Size 360.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0e86565b737792ab8c2f903a5b9f593bcbafdfc8b7a7fcce5d8b8f1514080a2b
BLAKE2b-256 checksum
How to use checksums
9d9cc513b25216e55c712e0fb1872ea61690b02686cb4584db0765095edb7a7f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for accessionflow 0.20.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page