Publishing
- .gitea/workflows/publish.yml publishes paperspec to the instance's PyPI
registry (/api/packages/infra/pypi) when a v* tag is pushed: it checks
the repository, builds the sdist and wheel, refuses to upload unless the
built version equals the tag, runs twine check --strict, and uploads
with the secrets PACKAGE_USER and PACKAGE_TOKEN (--skip-existing, so a
rerun on the same tag is safe). Run by hand, it refuses anything but a
tag.
- pixi dev environment: twine >= 6.1 (the first that reads Metadata 2.4),
and `dist` (sdist and wheel) replaces the `wheel` task.
- deploy/README.md: how to set up the secrets, release a version, and
install from the registry with pixi, uv or pip, tying paperspec to the
registry where the installer allows it.
- CONTRIBUTING.md "Releasing": a tag versions the package; a format
change takes the new format version as the top CHANGELOG heading, and a
code-only release takes the next patch as a subsection, as 0.1.1 does.
- pyproject: fallback_version 0+unknown for source trees without git; the
license expression is Apache-2.0 AND CC0-1.0, for the code and the data
the wheel carries.
Cleanup (from an audit of every reference to the package)
- spec/00 lists src/ (the package) and tools/ (how to run it), and no
longer says the reference implementation is not a library.
- Stale explanations fixed in pixi.toml, .gitignore, the Caddyfile, the
vectors, context, sql and tools READMEs, docs/examples.md, docs/faq.md,
spec/01, docs/rationale.md and docs/comparison.md: the commands, what
they need (the tools extra), the fixture folder hale2026harmonic-damb,
and three lines that held two sentences.
- tools/README.md counts all six commands, says what needs which extra
(package.validate and corrections.gate need [schema]), and that the
vectors ship but the fixtures they name do not.
- The CLI's install and clone hints point at the registry instructions and
an https clone URL; schema.py raises an ImportError naming
paperspec[schema], as crypto.py does for [crypto].
- check's Unicode check now guards the package's pinned constant.
- site skips build/, dist/ and *.egg-info.
- CHANGELOG 0.1.1 describes the final state.
pixi run check passes (as `python -m paperspec check`); the rebuild is
byte-identical. pixi.lock needs `pixi lock` for twine before pushing: the
publish workflow installs with --locked.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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>
Python and Unicode
- requires-python is >=3.14,<3.15: 3.14 is the only Python with the
Unicode 16.0 data the specification pins (3.13 has 15.1, 3.15 has 17.0).
- `import paperspec` raises ImportError unless unicodedata reports
paperspec.UNICODE_VERSION (16.0.0), so a source checkout or an install
that bypasses requires-python cannot compute values on other data.
Commands
- tools/{check,build,validate,load,stress,site}.py move with history to
src/paperspec/cli/ and install as paperspec-check, -build, -validate,
-load, -stress and -site; each also runs as `python -m paperspec.cli.X`.
- paperspec.cli.require() exits with "install paperspec[tools]" when
cryptography or jsonschema is missing; paperspec.cli.checkout() finds
the repository the check, build, stress and site commands work on (the
editable install's own checkout, else the one around the current
folder) and exits with a message outside one. tools/__init__.py is gone.
- validate and load read the schemas and SQL through the new
paperspec.resources.path(), which finds them in a wheel and in an
editable install alike, so they work anywhere the package is installed.
- check runs the rebuild as `python -m paperspec.cli.build`.
- build still writes the provenance tool label "paperspec tools/build.py":
it is part of every hashed and signed fixture.
- pixi tasks and the check workflow run the commands; tools/README.md
documents them, and the other docs name the commands instead of paths.
License
- LICENSE.md gives `src/` Apache-2.0 alongside `tools/`. Since the
previous commit moved the code to src/, no row had covered it.
pixi run check passes (run as `python -m paperspec.cli.check` with src/ on
the path, since this environment cannot install the entry points); the
byte-for-byte rebuild matches, so no fixture or vector changed.
pixi.lock still needs `pixi lock`.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The specification pins the Unicode 16.0 character data (spec/01 §1.4),
which Python 3.14 is the first to ship; Python 3.12 has 15.0 and 3.13 has
15.1, so text with characters added in 16.0 could normalize differently
there. The tools already required 3.14; the package now does too.
- pyproject.toml: requires-python >= 3.14, with the 3.14 classifier.
- The package and tools docstrings, tools/README.md and the changelog say
3.14 instead of 3.12.
pixi.lock still needs `pixi lock` (see the previous commit); its paperspec
entry also records the old requires-python.
pixi run check passes; no computed value changed.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The oracle had two import names, `tools.oracle` for the tools and
`paperspec` for other repositories, which could load the same code twice
in one process and needed a gate keyed on the module name. It now lives
in the standard src layout under its one name.
- git mv tools/oracle -> src/paperspec; the 22 rule modules are unchanged.
- The tools import `paperspec`. `tools/__init__.py` now holds the Python
3.14 and cryptography/jsonschema check and puts src/ first on sys.path,
so the tools run this checkout's code with or without pixi. The
package's own __init__ checks nothing and exposes __version__.
- pyproject.toml: version from git tags via setuptools-scm
(guess-next-dev, node-and-timestamp, src/paperspec/_version.py,
gitignored). The packages stay listed rather than found because
schemas/, sql/ and vectors/ stay at the root: the spec links to them and
the site serves the schemas at their $id URLs.
- pixi.toml: a `dev` feature and environment with setuptools,
setuptools-scm and python-build, and `pixi run -e dev wheel`.
- check.py scans src/paperspec for rule IDs; README, CONTRIBUTING, the
FAQ, the overview, the vectors and tools READMEs and the changelog point
at the new path. The FAQ no longer says the oracle is not a library.
pixi.lock is not re-solved in this commit: with a dynamic version, pixi
builds the package metadata to lock, which needs the conda environment
installed. Run `pixi lock` and commit the result before pushing; the site
workflow installs with --locked.
pixi run check passes; no computed value, vector, fixture, schema or SQL
file changed.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Other repositories (paperstack, then paperpack) import the reference
implementation instead of reimplementing the specification; scienting-core
will take the role later behind the same vectors.
- pyproject.toml: distribution and import name `paperspec`, version 0.1.0,
Python >= 3.12, no base dependencies; `tools/oracle` is the package, and
`schemas/`, `sql/` and `vectors/` ship as the data subpackages
`paperspec.schemas`, `paperspec.sql` and `paperspec.vectors`. Extras
`schema`, `crypto` and `tools`.
- tools/oracle/__init__.py: the Python 3.14 and cryptography/jsonschema gate
runs only when imported as `tools.oracle` by the repository's own tools.
- crypto.py imports `cryptography` on first use of HKDF and Ed25519, with an
ImportError naming `paperspec[crypto]`; schema.py imports `jsonschema` and
`referencing` in `Store.validator` and `Store.registry`. package.py, db.py
and receipts.py then import on a bare interpreter.
- pixi.toml installs the package editable (pixi.lock re-solved; no conda pin
changed), so the tools and the package resolve to the same code.
- tools/README.md names the library surface and the extras; CHANGELOG.md
records the packaging change under 0.1.0, since check.py requires the
changelog's first heading to equal the format version.
No computed value, vector, fixture, schema or SQL file changed.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
alexmandClaude