alexmandClaude
88379d152c
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>
66 lines
2.6 KiB
TOML
66 lines
2.6 KiB
TOML
[build-system]
|
|
requires = ["setuptools>=80", "setuptools-scm>=8"]
|
|
build-backend = "setuptools.build_meta"
|
|
|
|
[project]
|
|
name = "paperspec"
|
|
dynamic = ["version"]
|
|
description = "The scienting formats: the reference implementation of every rule, with the JSON Schemas, SQL and test vectors as package data"
|
|
readme = "README.md"
|
|
license = "Apache-2.0"
|
|
license-files = ["LICENSE.md"]
|
|
authors = [{ name = "Scientific Computing Studio", email = "maintainer@scient.ing" }]
|
|
# Python 3.14 is the only version with the Unicode 16.0 character data the specification pins (spec/01 §1.4);
|
|
# 3.13 has 15.1 and 3.15 has 17.0, and the package refuses to import on either.
|
|
requires-python = ">=3.14,<3.15"
|
|
classifiers = [
|
|
"Development Status :: 3 - Alpha",
|
|
"Intended Audience :: Science/Research",
|
|
"Programming Language :: Python :: 3 :: Only",
|
|
"Programming Language :: Python :: 3.14",
|
|
"Topic :: Scientific/Engineering",
|
|
]
|
|
# The base package is standard library only. `schema.py` needs jsonschema and
|
|
# `crypto.py` needs cryptography; the repository's own tools need both.
|
|
dependencies = []
|
|
|
|
[project.optional-dependencies]
|
|
schema = ["jsonschema>=4.26", "referencing>=0.35"]
|
|
crypto = ["cryptography>=46"]
|
|
tools = ["paperspec[crypto,schema]"]
|
|
|
|
# One command with subcommands: paperspec validate, load, check, build, stress and site; `paperspec --help`
|
|
# says which work anywhere and which need a checkout.
|
|
[project.scripts]
|
|
paperspec = "paperspec.cli.main:main"
|
|
|
|
[project.urls]
|
|
Homepage = "https://paperspec.scient.ing"
|
|
Repository = "https://git.scient.ing/infra/paperspec"
|
|
Documentation = "https://paperspec.scient.ing/docs/"
|
|
|
|
# The code is `src/paperspec`. The schemas, SQL and vectors stay at the repository root, where the
|
|
# specification links to them and the website serves the schemas at their `$id` URLs, and travel with the
|
|
# package as data subpackages, so a consumer reads them with importlib.resources. That mapping is why the
|
|
# packages are listed rather than found.
|
|
[tool.setuptools]
|
|
packages = ["paperspec", "paperspec.cli", "paperspec.schemas", "paperspec.sql", "paperspec.vectors"]
|
|
|
|
[tool.setuptools.package-dir]
|
|
"" = "src"
|
|
"paperspec.schemas" = "schemas"
|
|
"paperspec.sql" = "sql"
|
|
"paperspec.vectors" = "vectors"
|
|
|
|
[tool.setuptools.package-data]
|
|
"paperspec.schemas" = ["*.json"]
|
|
"paperspec.sql" = ["*.sql"]
|
|
"paperspec.vectors" = ["*.jsonl"]
|
|
|
|
# The package version comes from git tags (v0.1.0 builds as 0.1.0, later commits as 0.1.1.devN). It is the
|
|
# version of this code, not of the formats, which CHANGELOG.md and pixi.toml carry.
|
|
[tool.setuptools_scm]
|
|
version_file = "src/paperspec/_version.py"
|
|
version_scheme = "guess-next-dev"
|
|
local_scheme = "node-and-timestamp"
|