rocrate-action-recorder

Python package to record calls of Python CLI commands into a Research Object Crate (RO-Crate). Useful to track which commands were executed, which files were used as input or output, and which software was used to execute the command.

Supports RO-Crate 1.1 specification. Specifically the Process Run Crate profile.

Provides adapters for CLIs based on:

Install

pip install rocrate-action-recorder

For Click support, install the optional extra:

pip install "rocrate-action-recorder[click]"

For Cyclopts support, install the optional extra:

pip install "rocrate-action-recorder[cyclopts]"

Usage

Example of recording a CLI command (example-cli input.txt output.txt) implemented with argparse.

import argparse
from pathlib import Path
import sys

from rocrate_action_recorder import recorded_argparse

parser = argparse.ArgumentParser(prog="example-cli", description="Example CLI")
parser.add_argument("--version", action="version", version="%(prog)s 1.2.3")
parser.add_argument("--no-record", action="store_false", help="Disable RO-Crate recording.")
parser.add_argument("input", type=Path, help="Input file")
parser.add_argument("output", type=Path, help="Output file")


@recorded_argparse(
    parser=parser,
    input_files=["input"],
    output_files=["output"],
    dataset_license="CC-BY-4.0",
    enabled_argument="no_record",
)
def handler(args: argparse.Namespace):
    # For demonstration, just upper case input to output, replace with real logic
    args.output.write_text(args.input.read_text().upper())


# Prepare input
Path("input.txt").write_text("hello")
# Simulate command-line arguments
sys.argv.extend(["input.txt", "output.txt"])

args = parser.parse_args()
handler(args)

After execution, a ro-crate-metadata.json file (like this one) will be generated in the current working directory, describing the execution of the CLI command.

You can also call the low-level record function directly.

See documentation for more details.

Contributions

See AGENTS.md for commands and hints for contributions.

Citation

See CITATION.cff for citation information.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rocrate_action_recorder-0.7.1.tar.gz (92.7 kB view details)

Uploaded Aug 4, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

rocrate_action_recorder-0.7.1-py3-none-any.whl (30.0 kB view details)

Uploaded Aug 4, 2026 Python 3

File details

Details for the file rocrate_action_recorder-0.7.1.tar.gz.

File metadata

Download URL: rocrate_action_recorder-0.7.1.tar.gz
Upload date: Aug 4, 2026
Size: 92.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for rocrate_action_recorder-0.7.1.tar.gz
Algorithm	Hash digest
SHA256	`0dedaa6a701e1e922da766a20bc7bc5997d3d808fe555afea332562733db551d`
MD5	`1252d3e2eb52b08e5ceb74f087a097f9`
BLAKE2b-256	`32941dad373acd0d7858316b303e65df38fef17f15257a5aa3682bc1e02d4977`

See more details on using hashes here.

Provenance

The following attestation bundles were made for rocrate_action_recorder-0.7.1.tar.gz:

Publisher: publish.yml on i-VRESSE/rocrate-action-recorder

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: rocrate_action_recorder-0.7.1.tar.gz
- Subject digest: 0dedaa6a701e1e922da766a20bc7bc5997d3d808fe555afea332562733db551d
- Sigstore transparency entry: 2340203092
- Sigstore integration time: Aug 4, 2026
Source repository:
- Permalink: i-VRESSE/rocrate-action-recorder@519653ff67326c2299af6d4f3779b29a56a706b4
- Branch / Tag: refs/tags/v0.7.1
- Owner: https://github.com/i-VRESSE
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@519653ff67326c2299af6d4f3779b29a56a706b4
- Trigger Event: release