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
results timestamp Date the ledger's head outside the repository, and check earlier dates

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.

results init writes a .results/.gitignore that ignores only the lock files, so the ledger and its anchor are committed with the project. A ledger on one disk is a record nobody else can check. What is committed is public with the repository, so a run's note is written as a commit message would be.

Timestamp

The chain catches a line edited by hand. It cannot catch the ledger and its anchor rewritten together, because whoever can write one can write the other. results timestamp sends the head to the OpenTimestamps calendars, which commit it into a Bitcoin block within a few hours, and keeps the proof under .results/timestamps/. Each line names the hash of the one before it, so a proof of the head dates every earlier event too.

events 1–153 existed by Bitcoin block 915004, 2026-10-03 16:12 UTC

results verify reads the proofs with no network. A proof whose head no longer matches the chain at its length means the ledger was rewritten after it was stamped:

TIMESTAMP CONTRADICTS THE CHAIN — the ledger was rewritten after it was stamped
  000153-3f9c2a1b7d4e5f60.ots dates event 153 as 3f9c2a1b7d4e5f60…, and the ledger's event 153 is 81d0…

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.

Metadata

Release files for results-cli 0.5.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 results-cli 0.5.0
File Size Uploaded
results_cli-0.5.0.tar.gz 48.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for results-cli 0.5.0
File Interpreter ABI Platform
results_cli-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 79.4 kB

Release files / results_cli-0.5.0.tar.gz

Download URL results_cli-0.5.0.tar.gz
Size 48.3 kB
Tags Source
SHA-256 checksum
How to use checksums
7bc6f0a4459893d756b3a89c8ba89773e6313853ff2662d40d480b4ace11c4dc
BLAKE2b-256 checksum
How to use checksums
6604433a394ca95bf092048a34a4d69bb7957c3d390e1081044a92b8411194c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.

Transparency log

Release files / results_cli-0.5.0-py3-none-any.whl

Download URL results_cli-0.5.0-py3-none-any.whl
Size 31.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
efe6a3a75a836e915ca9e8e486e4a5d8afb156c004b647b1911d9fda609c5af7
BLAKE2b-256 checksum
How to use checksums
6097ce86da74179c8541aa00e5b44a5c2913af2496dcdc8aa48dc59f2e855920
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 6, 2026.

Transparency log

Release history Release notifications | RSS feed

0.6.1

2 release files

0.6.0

2 release files

0.5.6

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

This release

0.5.0 This release

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release 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