infra/paperspec
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
88379d152ce3ace8678cb73693231b76cbdfbfef
paperspec/CHANGELOG.md
T
alexmandClaude 88379d152c feat!: one paperspec command with subcommands, help and examples 
The six console scripts (paperspec-check, -build, -validate, -load,
-stress, -site) become subcommands of a single `paperspec` command:
paperspec validate, load, check, build, stress and site. `python -m
paperspec COMMAND` runs the same thing.

- paperspec/cli/main.py builds the whole parser, apart from the commands,
  so `paperspec --help` and `paperspec COMMAND --help` work without a
  checkout or the tools extra; a command's module is imported only when
  it runs.
- `paperspec` with no command prints the overview: what each command does,
  examples, and which work anywhere (validate, load) and which need a
  checkout (check, build, stress, site). Each command's help has a
  description with advice, and worked examples; a misspelled command gets
  a suggestion (argparse suggest_on_error); `--version` prints the version
  and the pinned Unicode version.
- Each command module exposes run(args) and returns the exit status.
  Arguments that parse but do not fit together raise UsageError, which
  prints the command's usage and exits 2: load now also refuses
  --built-from or --store without --bundle.
- The failure messages say what to do: install paperspec[tools], clone the
  repository, rerun stress with the printed seed, or run paperspec build
  when the rebuild check differs. check and stress say how many failures
  they did not list.
- check runs the rebuild as `python -m paperspec build`.
- pyproject installs one script, `paperspec`; the pixi tasks and the docs
  use the subcommands.

pixi run check passes (run here as `python -m paperspec check` with src/ on
the path); the rebuild is byte-identical. pixi.lock still needs
`pixi lock`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 09:28:30 -04:00

4.0 KiB
Raw Blame History

Changelog

A change to any computed value is a breaking change and needs a new major version of the format it touches; see spec/00-introduction.md.

0.1.0

The first release.

  • The specification, in chapters 0 to 23, covering every format: 32 formats, of which 19 are candidate and 13 provisional.
  • 42 JSON Schemas, using a keyword subset that independent validators read alike.
  • Tables for SQLite, Dolt and PostgreSQL, a team's store, and the SQLite bundle with full-text search.
  • The JSON-LD context for layers, and registries of formats, rules, download-stamp rules and default stage requirements.
  • Test vectors for every computed value, from canonical JSON to anchor resolution, grading and the target set of targeted F3.
  • Example packages (a converted chemistry paper with corrections and receipts, its checks-only export, an open-access paper, a Typst draft and a tiny document, also as a zip), a record of every other format, and 31 broken packages, each breaking one named rule.
  • Work keys minted from a Scholar-style citation key and a hash of the work's identity, with document keys for versions; tag: URIs for layers, annotations and documents.
  • Spot-check seeds as VRF proofs (RFC 9381), RFC 9162 inclusion and consistency proofs, a history root over every document's corrections, and a provisional transparency log with signed checkpoints.
  • Signed QA reports, a conformance checklist covered by a receipt, and a description annotation for the figure descriptions an accessible export needs.
  • ML-DSA-65 (FIPS 204) as a signature scheme, with a reference implementation checked against NIST's vectors; cose reserved; did:key identifiers for roster keys; the hash algorithm named in every document; model provenance by weights, prompt and parameters; witnesses and a static tile layout for the log; and the character data pinned to Unicode 16.0.
  • Guides for newcomers: an overview, the concepts, a walkthrough of the example paper, runnable examples, the rationale, a FAQ and a glossary.
  • Tools that build and check everything, validate packages and zipped packages and run proposed corrections through the gate, load packages into SQLite or a bundle, and stress the reference implementation with random inputs.
  • A pixi workspace pinned to Python 3.14, with tasks for checking, building, linting, validating and loading.

0.1.1

Packaging, commands and lazy imports only; the formats stay at 0.1.0, and no computed value, vector, fixture, schema or SQL file changed.

  • The oracle moves from tools/oracle/ to src/paperspec/ and installs as the Python package paperspec (pyproject.toml, setuptools), with schemas/, sql/ and vectors/ as the data subpackages paperspec.schemas, paperspec.sql and paperspec.vectors, so other repositories import the reference implementation instead of reimplementing it.
  • The package version comes from git tags through setuptools-scm.
  • The base package has no dependencies and requires Python 3.14, the only version with the Unicode 16.0 character data the specification pins, and refuses to import under any other Unicode version; the extras paperspec[schema] (jsonschema, referencing), paperspec[crypto] (cryptography) and paperspec[tools] (both) cover schema and the HKDF and Ed25519 functions of crypto, which now import their packages on first use.
  • paperspec.resources.path finds the schemas, SQL and vectors in an installed wheel and in an editable install alike.
  • The programs in tools/ become subcommands of one command, paperspec, in src/paperspec/cli/: paperspec validate, load, check, build, stress and site, which the pixi tasks and the workflow run, and which python -m paperspec also runs.
  • paperspec --help says which commands work anywhere and which need a checkout, and each command's --help gives advice and examples; a misspelled command gets a suggestion.
  • src/ is Apache-2.0, as tools/ was.
  • The pixi workspace installs the package editable, and a dev environment builds the wheel with pixi run -e dev wheel.
Reference in new issue View Git Blame Copy Permalink