Skip to main content

results

pypi python license docs

Seal inputs, record outputs, and bind a paper's claims to the runs behind them.

Part of reproducible-science alongside repro, citations and prereg — see the documentation.

Install

pip install results-cli

Quick start

results init
results seal prereg.md analysis.py data.csv --role input
results access "read zenodo metadata" --level "metadata only"

# run the computation, then record its outputs
results run output.json --run-id exp_001 --note "ICC analysis"
results claim "ICC = 0.42" --run-id exp_001 --confirmatory --location "Table 2"
results verify --files
chain intact: 5 events

  access       1
  claim        1
  init         1
  run          1
  seal         1

file hashes:
  ok         prereg.md
  ok         analysis.py
  ok         data.csv
  ok         output.json

all checks passed.

Commands

Command What it does
results init Start tracking results here
results seal <file>... Hash inputs before a run
results access <note> Record a data-access event
results run <file>... Record outputs after a run
results claim <text> Bind a manuscript claim to a run
results verify Check the ledger chain and every hash it names

The chain

A number in a manuscript names a claim. The claim names a run. The run names its outputs. The outputs were hashed when they were recorded. The inputs were hashed before the run started.

manuscript  →  claim  →  run  →  output file  →  sha256
                                  input files  →  sha256

results verify --files walks the whole thing and tells you what moved.

Data-access levels

The access timeline is what makes the confirmatory/exploratory distinction verifiable.

Level Meaning
nothing seen No target data touched
metadata only Structure, region names, sample sizes — not outcomes
structure seen Data shape and distributions, not the target variable
outcomes seen The dependent variable was observed

An analysis registered after outcomes seen is retrospective.

Verify output

Result Meaning
chain intact Every event's prev_hash matches the line before it
CHAIN BROKEN The ledger was edited after it was written
ok File matches its recorded hash
CHANGED File was modified since it was recorded
MISSING File no longer exists

The ledger

Append-only JSONL in .results/ledger.jsonl. Each line is hash-chained to the previous — editing or inserting a line breaks the chain. git diff shows what changed; results verify checks whether it should have.

Claude Code

plugin/ is a Claude Code plugin. Three surfaces, because each catches a different failure: the hook catches what the model does not think to do, the skill catches what you did not know to ask for, and the command is there for when you want the answer now.

surface fires
hook when a number enters a manuscript that no recorded claim names
skill when Claude judges the situation calls for sealing inputs, recording outputs, binding a paper's claims to runs
command when you type /results-check

Why the hook. The address is on screen while the sentence is being written and gone immediately afterward. A number recovered later has to be matched by its digits, and a value reported to two or three significant figures matches something in an artifact of any size.

It reports and never blocks, and stays silent in a project with no .results/ ledger.

/plugin marketplace add elliottower/reproducible-science
/plugin install results@reproducible-science

The plugin ships instructions and hooks, not binaries, so install the tool as well:

uv tool install results-cli    # or: pip install results-cli

All four tools in one plugin, with every hook, skill and command:

/plugin install reproducible-science@reproducible-science

MIT licensed.

This tool and repro

results installs and runs on its own, is not deprecated, and is not going to be. reproducible-science depends on it, so repro results ... runs this same command with the same arguments and the same exit code. That is a spelling, not a feature.

What only exists in the umbrella is repro check, which runs every tool a project uses in one pass, with one report and one exit code, and names the tools the project does not use rather than counting them as passing. If a project only records runs, use this command directly.

Download files

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

Source Distribution

results_cli-0.4.0.tar.gz (42.3 kB view details)

Uploaded Source

Built Distribution

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

results_cli-0.4.0-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

Details for the file results_cli-0.4.0.tar.gz.

File metadata

  • Download URL: results_cli-0.4.0.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for results_cli-0.4.0.tar.gz
Algorithm Hash digest
SHA256 ae0da65bddfd2203b1bbadafd4ae609be79e22315eef5a22aad62d5912987595
MD5 8525c1a90d7cc09b3847a20851d5bb3d
BLAKE2b-256 73ba12beae33cfc43da690b68cc4759f71208cf24c216feaeb4c56764a956e17

See more details on using hashes here.

Provenance

The following attestation bundles were made for results_cli-0.4.0.tar.gz:

Publisher: publish-results.yml on elliottower/reproducible-science

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

File details

Details for the file results_cli-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: results_cli-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 27.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for results_cli-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 04e1cf6a6c49b13a7e75fd12b753351885e552e6c1c52f7d332c07586ad03b8a
MD5 02f73ccd70c261acb8b4c1c3e3476247
BLAKE2b-256 594667b3e82ddae42b816ca52f456c94680ce94afca86c680950a686240069ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for results_cli-0.4.0-py3-none-any.whl:

Publisher: publish-results.yml on elliottower/reproducible-science

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

Release history Release notifications | RSS feed

0.4.2

2 files

0.4.1

2 files

This release

0.4.0 This release

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

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