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,...).
flowchart LR
Folder(["folder"]) --> Collate["collate (source)"]
Orthanc(["Orthanc"]) --> Collate
Collate --> Label["label (store)"]
Label --> Deidentify["deidentify (optional)"]
Deidentify --> Store["store (store)"]
Store --> XNAT[("XNAT")]
Store --> FolderStore[("folder store\n(local, S3, SFTP)")]
Store -.-> CheckStore["check-store (store)"]
Extra(["files without\nsorting metadata"]) -.-> Attach["attach (optional)"]
Collate -.-> Attach
Attach -.-> Label
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.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| accessionflow-0.20.0.tar.gz | 270.9 kB | Without provenance | Details for accessionflow-0.20.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| accessionflow-0.20.0-py3-none-any.whl | Python 3 | none | any | Details for accessionflow-0.20.0-py3-none-any.whl |
Total release size: 620.1 kB
Release files / accessionflow-0.20.0.tar.gz
| Download URL | accessionflow-0.20.0.tar.gz |
|---|---|
| Size | 270.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b002f78dcfca16db48d7617c7f31eb2dd98cab5e188b2fcfe36341329e27dc06
|
|
BLAKE2b-256 checksum How to use checksums |
266ede09d6f5a73938d843648dd74e39f78c5ca345a6ed340e5a5bae01101a63
|
| 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.0-py3-none-any.whl
| Download URL | accessionflow-0.20.0-py3-none-any.whl |
|---|---|
| Size | 349.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c836802d78c1ddc6dccc54b175791b1025754d66d74117b0519587598e8f5ce3
|
|
BLAKE2b-256 checksum How to use checksums |
cb2415818225c4439776cc050731dc1b3c3969e352798a4781066ba4a1d01d2b
|
| 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.0
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.