acorn-py 🌱

Python bindings for the acorn-lib crate

So what? Big deal...who cares?

acorn-py provides Python bindings for selected APIs from ACORN's acorn-lib and acorn-schema Rust crates. The Python package is independently versioned from ACORN.

Installation

Pixi

⭐ Recommended

pixi add acorn-py --pypi

Poetry

poetry add acorn-py

Pip

pip install acorn-py

Example Usage

from acorn.schema.validate import is_ark, is_arxiv, is_doi, is_orcid, is_ror

# Archival Resource Keys
assert is_ark("https://n2t.net/ark:12148/btv1b8449691v/f29")

# arXiv identifiers
assert is_arxiv("arXiv:2106.09685")

# Digital Object Identifiers
assert is_doi("10.11578/dc.20250604.1")

# Open Researcher and Contributor Identifiers
assert is_orcid("https://orcid.org/0000-0002-2057-9115")

# Research Organization Registry identifiers
assert is_ror("01qz5mb56")

Compatibility

The distribution requires Python 3.10 or newer and uses a CPython stable-ABI wheel built with Maturin. The initial standalone release pins acorn-lib and acorn-schema 0.1.76 to a public ACORN commit because acorn-schema is not yet available from crates.io. Binding versions do not track Rust crate versions.

acorn-py exposes a selected API rather than the entire ACORN library. See the binding source for the registered classes and functions.

Development

Install Pixi, then run:

make check
make test
make wheel-smoke

The test matrix covers Python 3.10 and 3.13. make wheel-smoke builds the ABI3 wheel, installs it into a clean environment, imports acorn, and verifies package metadata.

Publishing

See the maintainer release checklist for the complete versioning, validation, tagging, and approval procedure.

GitLab CI always builds a source distribution and a manylinux2014 x86-64 wheel. With matching project runners, enable ACORN_PY_ENABLE_LINUX_ARM64, ACORN_PY_ENABLE_MACOS_X86_64, ACORN_PY_ENABLE_MACOS_ARM64, and ACORN_PY_ENABLE_WINDOWS_X86_64 to add Linux ARM64, both macOS architectures, and Windows x86-64 wheels. Native macOS and Windows runners must provide Pixi; Linux uses the pinned official Maturin image.

Linux wheel builds use vendored OpenSSL so both manylinux architectures have the same supported cryptographic dependency instead of relying on the build image's system OpenSSL.

Issues in Python wrappers, packaging, or wheels belong in the acorn-py issue tracker. Issues in the underlying Rust behavior belong in the ACORN issue tracker.

Linux note

On Linux, you may need to augment your pixi.toml with:

[system-requirements]
libc = { family = "glibc", version = "2.34" }