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 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>
- Rename manuspec to paperspec everywhere outside pixi.toml: prose, the
tools, provenance tool names and the fixture key derivations, so every
fixture and vector is rebuilt.
- Move the namespace addresses under the site, mirroring the repository:
schema $id https://paperspec.scient.ing/schemas/<file>, the JSON-LD
context https://paperspec.scient.ing/context/scienting-1.jsonld, and
term IRIs https://paperspec.scient.ing/vocab#<term>. Format
identifiers (scienting-*) and URNs (urn:scienting:) are unchanged.
- tools/site.py (standard library only) builds _site/: every file of the
repository at its own path, each Markdown file rendered as a page with
sidebar navigation, heading anchors matching the forge's, folder
listings, a vocabulary page for the context's IRIs, a heading search
and a 404 page; light and dark themes.
- check.py builds the site and checks that every Markdown file has a
page, every internal link and fragment resolves, no Markdown is left
unrendered, and every $id, the context address and the vocabulary IRIs
are files of the site.
- deploy/: a Caddyfile with the media types and CORS the data needs, and
a guide; .gitea/workflows/site.yml builds on main and publishes with
rsync when the SITE_* secrets are set.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
alexmandClaude