diff --git a/pyproject.toml b/pyproject.toml index b98ddbd..24d81c5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,3 @@ -# Package metadata only, and the build mapping setuptools needs. Tool settings live in their own files: -# pixi.toml (environments + tasks), .ruff.toml (lint/format), ty.toml (types), .pytest.ini (tests), -# .coveragerc (coverage). -# Deviation from the Scienting standard: setuptools with setuptools-scm instead of hatchling with hatch.toml. -# The package maps schemas/, sql/ and vectors/ from the repository root as data subpackages, and takes its -# version from git tags. - [build-system] requires = ["setuptools>=80", "setuptools-scm>=8"] build-backend = "setuptools.build_meta" @@ -14,22 +7,17 @@ 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 = "Scienting", 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", + "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] @@ -37,8 +25,6 @@ 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" @@ -49,34 +35,28 @@ Specification = "https://paperspec.scient.ing" Repository = "https://git.scient.ing/papers/paperspec" Changelog = "https://git.scient.ing/papers/paperspec/src/branch/main/CHANGELOG.md" -# PEP 735 dependency groups (pip >= 25.1: `pip install -e ".[tools]" --group dev`). -# pixi.toml mirrors these for conda-forge environments. The tests need the `tools` extra as well. [dependency-groups] test = ["pytest>=8.4", "pytest-cov>=6", "hypothesis>=6.130"] lint = ["ruff>=0.17.1,<0.18", "ty>=0.0.89,<0.0.90"] dev = [ - { include-group = "test" }, - { include-group = "lint" }, - "pre-commit>=4", - "build>=1.2", - "twine>=6.1", + { include-group = "test" }, + { include-group = "lint" }, + "pre-commit>=4", + "build>=1.2", + "twine>=6.1", ] -# The code is `src/paperspec`. The schemas, SQL, vectors, registries and JSON-LD context 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", - "paperspec.registry", - "paperspec.registry.stamps", - "paperspec.registry.stages", - "paperspec.context", + "paperspec", + "paperspec.cli", + "paperspec.schemas", + "paperspec.sql", + "paperspec.vectors", + "paperspec.registry", + "paperspec.registry.stamps", + "paperspec.registry.stages", + "paperspec.context", ] [tool.setuptools.package-dir] @@ -96,9 +76,6 @@ packages = [ "paperspec.registry.stages" = ["*.json"] "paperspec.context" = ["*.jsonld"] -# 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" diff --git a/ty.toml b/ty.toml index a451f30..006d101 100644 --- a/ty.toml +++ b/ty.toml @@ -1,4 +1,3 @@ -# ty type checker. https://docs.astral.sh/ty/reference/configuration/ [environment] python-version = "3.14" python-platform = "all" diff --git a/zensical.toml b/zensical.toml index 9359329..f03c1db 100644 --- a/zensical.toml +++ b/zensical.toml @@ -1,6 +1,3 @@ -# The documentation site (Zensical): https://docs.scient.ing/paperspec/ -# `pixi run -e docs docs-build` builds it strictly into build/docs; `docs-serve` previews it. - [project] site_name = "paperspec" site_description = "The Python package and the commands of paperspec, the reference implementation of the scienting formats" @@ -8,13 +5,10 @@ site_url = "https://docs.scient.ing/paperspec/" repo_url = "https://git.scient.ing/papers/paperspec" repo_name = "papers/paperspec" copyright = "Scienting" -# paperspec-specific: docs/ already holds the guides to the formats, which `paperspec site` renders on -# https://paperspec.scient.ing, so these pages for the Python package live in a subfolder of it. docs_dir = "docs/package" site_dir = "build/docs" use_directory_urls = true -# Every page appears here, so a page nobody links to fails the strict build. nav = [ { "Home" = "index.md" }, { "Get started" = [ @@ -44,7 +38,7 @@ nav = [ [project.theme] language = "en" -font = false # system fonts: no request to a font host +font = false features = [ "content.code.annotate", "content.code.copy",