alexmandClaude
516148146f
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>
69 lines
2.9 KiB
TOML
69 lines
2.9 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"
|
|
# The code (src/) is Apache-2.0 and the schemas, SQL and vectors it carries are CC0-1.0, as LICENSE.md says.
|
|
license = "Apache-2.0 AND CC0-1.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.1 builds as 0.1.1, later commits as 0.1.2.devN); CONTRIBUTING.md
|
|
# says how it relates to the format version that CHANGELOG.md and pixi.toml carry. A source tree without git
|
|
# history, such as a downloaded archive, builds as 0+unknown instead of failing.
|
|
[tool.setuptools_scm]
|
|
fallback_version = "0+unknown"
|
|
version_file = "src/paperspec/_version.py"
|
|
version_scheme = "guess-next-dev"
|
|
local_scheme = "node-and-timestamp"
|