[workspace] name = "paperspec" version = "0.1.0" description = "The scienting data formats: specification, JSON Schemas, SQL, test vectors and fixtures" authors = ["Scienting "] license = "CC-BY-4.0 AND CC0-1.0 AND Apache-2.0" license-file = "LICENSE.md" readme = "README.md" homepage = "https://paperspec.scient.ing" repository = "https://git.scient.ing/papers/paperspec" documentation = "https://paperspec.scient.ing/docs/" channels = ["conda-forge"] platforms = ["linux-64", "linux-aarch64", "osx-64", "osx-arm64"] requires-pixi = ">=0.50" [dependencies] python = ">=3.14,<3.15" # the package's tools extra, as in pyproject.toml jsonschema = ">=4.26.0" cryptography = ">=46" # the Markdown lint (`pixi run lint-md`) markdownlint-cli2 = ">=0.23.3" nodejs = ">=22" # The reference implementation in src/paperspec, installed editable so that `import paperspec` and the # `paperspec` command work in every pixi environment; without pixi, `pip install -e ".[tools]"` does the same. [pypi-dependencies] paperspec = { path = ".", editable = true } [feature.test.dependencies] pytest = ">=8.4" pytest-cov = ">=6" hypothesis = ">=6.130" [feature.lint.dependencies] ruff = ">=0.17.1,<0.18" pre-commit = ">=4" [feature.lint.pypi-dependencies] ty = ">=0.0.89,<0.0.90" # What building and publishing the package needs: pixi run -e release dist; see deploy/README.md. # setuptools and setuptools-scm replace the standard's hatchling (the package keeps setuptools-scm). # twine 6.1 is the first that reads the license metadata (Metadata-Version 2.4) setuptools writes. [feature.release.dependencies] setuptools = ">=80" setuptools-scm = ">=8" python-build = ">=1.2" twine = ">=6.1" [feature.release.tasks] dist = { cmd = "python -m build --sdist --wheel --no-isolation --outdir dist", description = "Build the sdist and wheel into dist/" } # The package documentation (docs/package/), built with Zensical as in paperclaim. [feature.docs.dependencies] zensical = ">=0.0.69,<0.0.70" [feature.docs.tasks] docs-build = { cmd = "zensical build --strict", description = "Build the documentation strictly into build/docs" } docs-serve = { cmd = "zensical serve", description = "Preview the documentation locally" } [environments] # `default` has everything for development; `release` builds and publishes the package; `docs` builds the docs. default = { features = ["test", "lint"], solve-group = "default" } release = { features = ["release"], solve-group = "default" } docs = { features = ["docs"], solve-group = "default" } [tasks] fmt = { cmd = "ruff format", description = "Format code" } fmt-check = { cmd = "ruff format --check", description = "Check formatting" } lint = { cmd = "ruff check", description = "Lint" } lint-fix = { cmd = "ruff check --fix", description = "Lint and apply fixes" } typecheck = { cmd = "ty check", description = "Type-check src with ty" } test = { cmd = "pytest", description = "Fast suite: unit, property, integration, doctests" } cov = { cmd = "pytest -m 'not live' --maxfail=0 --cov --cov-report=term-missing --cov-report=xml", description = "All offline tests with branch coverage (fails under 90%)" } lint-md = { cmd = "markdownlint-cli2", description = "Lint every Markdown file with markdownlint" } verify = { cmd = "paperspec check", description = "Check schemas, records, packages, vectors, a byte-for-byte rebuild, the SQL round trip, prose and links" } check = { depends-on = [ "fmt-check", "lint", "typecheck", "lint-md", "test", "verify", ], description = "Every code check CI runs, then the repository's own check" } hooks = { cmd = "pre-commit install", description = "Install git pre-commit hooks" } quick = { cmd = "paperspec check --quick", description = "Check everything except the byte-for-byte rebuild" } build = { cmd = "paperspec build", description = "Rebuild fixtures/ and vectors/ from fixtures/src/ and the oracle" } load = { cmd = "paperspec load", description = "Load packages into SQLite: pixi run load --sqlite lab.db PACKAGE..." } validate = { cmd = "paperspec validate", description = "Validate packages, or run proposed corrections through the gate" } stress = { cmd = "paperspec stress", description = "Stress the oracle with random inputs: pixi run stress --seed N" } site = { cmd = "paperspec site", description = "Build the website into _site/" }