Skip to main content

axiom-annotations

Zero-dependency Python package providing the shared annotation vocabulary used by axiom-graph.

Contains:

  • @workflow and @task decorators
  • Step() and AutoStep() inline markers
  • StepValidationError exception
  • Per-marker argument validation helpers

All markers are pure Python with no third-party runtime dependencies. This lets downstream tools annotate their code with workflow/task/Step/AutoStep markers without pulling in any heavier optional runtime stack.

Install

pip install axiom-annotations

Usage

from axiom_annotations import workflow, task, Step, AutoStep

@task(purpose="Load data from file")
def load_data(path: str):
    ...

@workflow(purpose="Run the analysis pipeline")
def run_pipeline(path: str):
    ax = AutoStep(step_num=1)
    data = load_data(path)

    ax = Step(step_num=2, name="Filter", purpose="Remove bad rows")
    data = [r for r in data if r.quality > 0.5]

Registry hook

By default @workflow and @task just validate and pass the function through. Tools that want to collect decorated functions into a registry can install a hook:

from axiom_annotations.decorators import set_register_hook

def my_register(func, *, purpose, kind, inputs, outputs, critical):
    ...  # persist to your own registry

set_register_hook(my_register)

axiom-graph installs such a hook during scanning to populate its index.

Metadata

Release files for axiom-annotations 0.1.0

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

Source distribution (sdist)

Source distribution for axiom-annotations 0.1.0
File Size Uploaded Provenance Actions
axiom_annotations-0.1.0.tar.gz 5.5 kB Without provenance Details for axiom_annotations-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for axiom-annotations 0.1.0
File Interpreter ABI Platform Actions
axiom_annotations-0.1.0-py3-none-any.whl Python 3 none any Details for axiom_annotations-0.1.0-py3-none-any.whl

Total release size: 12.6 kB

Release files / axiom_annotations-0.1.0.tar.gz

Download URL axiom_annotations-0.1.0.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f1f8eaf275205fc1f48a99ca0a255c465a0cdaf69e82caffcb2ce3b1cdae88d9
BLAKE2b-256 checksum
How to use checksums
e9c5790d3f7a1275c85615c82efae6873c30f59acaa808abc66215e90df6fab4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.10.9 Windows/10

Release files / axiom_annotations-0.1.0-py3-none-any.whl

Download URL axiom_annotations-0.1.0-py3-none-any.whl
Size 7.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
92234394d96428f380d7ade22f1af7653a7b09e3fb5ea68ab164d43ef0d30279
BLAKE2b-256 checksum
How to use checksums
f0840b0ed0d90efcf51574d0cad6b9a1cdc41280c242f983109658bb3718e1a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.10.9 Windows/10

Security for axiom-annotations 0.1.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.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

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