Use the name Scienting
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01B8cL4zN4XpaQF5cBtASzfq
This commit is contained in:
12 files changed
+20
-16
No files matched your search
@@ -1,6 +1,6 @@
|
||||
# Continuous integration on Gitea Actions.
|
||||
#
|
||||
# Runner labels: `linux-base` is the label of this studio's runner. If your
|
||||
# Runner labels: `linux-base` is the label of Scienting's runner. If your
|
||||
# runner registers different labels, change the `os` matrix.
|
||||
# Forgejo and Gitea Actions both read .github/workflows when their own folder is absent.
|
||||
# On Forgejo, if the runner's default action mirror lacks setup-pixi, write it as
|
||||
|
||||
+6
-2
@@ -138,14 +138,18 @@ It is a minor change in the sense of [spec/00](spec/00-introduction.md): one new
|
||||
|
||||
Tooling and code quality only; no computed value, vector, fixture, schema or SQL file changes.
|
||||
|
||||
- The Python code meets the studio's standard: `ruff format`, `ruff check` with the full rule set, and `ty check` pass on `src/paperspec`, every function is annotated and documented, and `tests/` holds a pytest suite, driven by the vectors and fixtures, with branch coverage that fails under 90%.
|
||||
- The Python code meets Scienting's standard: `ruff format`, `ruff check` with the full rule set, and `ty check` pass on `src/paperspec`, every function is annotated and documented, and `tests/` holds a pytest suite, driven by the vectors and fixtures, with branch coverage that fails under 90%.
|
||||
`paperspec check` (with the byte-for-byte rebuild) and `paperspec stress` give the same results as before.
|
||||
- Fixed: `structures.scan` raised an unrelated `ValueError` ("unsupported format character") for a malformed ring closure such as `C%1`, because its message was an invalid format string; the message is now "% needs two digits at N".
|
||||
- Fixed: `paperspec site --out /` passed the check that the output folder does not contain the repository and went on to delete the folder it was given; it is now refused as a usage error.
|
||||
A site built into a folder inside the checkout also no longer copies that folder's subfolders into itself.
|
||||
- Fixed: `receipts.verify_signature`, documented never to raise, raised `KeyError` for a record without a `format`; it now returns false.
|
||||
- Fixed: `traces.DOC_TAG` matched a document tag followed by a line feed, because it ended in `$`; it now ends at the end of the string.
|
||||
- Fixed: `paperspec load` and `paperspec check` left their SQLite connections open; they now close them.
|
||||
- The pixi tasks follow the standard (`fmt`, `fmt-check`, `lint` for ruff, `typecheck`, `test`, `cov`, `hooks`); the Markdown lint is `lint-md`, `paperspec check` is also `verify`, and `check` runs them all.
|
||||
The build environment is `release` (was `dev`), and `docs` builds the package documentation.
|
||||
- The package documentation, for the Python package and its command, is built with Zensical from `docs/package/` and published at <https://docs.scient.ing/paperspec/>; the format documentation stays in `docs/` and on <https://paperspec.scient.ing>.
|
||||
- The repository lives in the Gitea organization `papers`: the repository and registry addresses change from `infra` to `papers`.
|
||||
- The publish workflow also creates the Gitea release, with the files attached and the notes taken from this changelog; CI runs the studio's checks (`.gitea/workflows/ci.yml`) on `main`, `dev` and pull requests.
|
||||
- The publish workflow also creates the Gitea release, with the files attached and the notes taken from this changelog; CI runs Scienting's checks (`.gitea/workflows/ci.yml`) on `main`, `dev` and pull requests.
|
||||
- Python files open with an `SPDX-License-Identifier: Apache-2.0` header, which ruff and a test check.
|
||||
- The checker and the site builder skip `work/`, caches and build output.
|
||||
+1
-1
@@ -22,7 +22,7 @@ The schemas, SQL, registries, vectors and fixtures then follow the chapter ([spe
|
||||
|
||||
## How the checks run
|
||||
|
||||
The Python code follows the studio's standard: ruff formats and lints it with `.ruff.toml`, ty checks its types with `ty.toml`, and pytest tests it with `.pytest.ini` and `.coveragerc`.
|
||||
The Python code follows Scienting's standard: ruff formats and lints it with `.ruff.toml`, ty checks its types with `ty.toml`, and pytest tests it with `.pytest.ini` and `.coveragerc`.
|
||||
`pixi run check` runs, in order, `fmt-check` (ruff format), `lint` (ruff check), `typecheck` (ty), `lint-md` (markdownlint), `test` (pytest) and `verify` (`paperspec check`, the repository's own checker).
|
||||
`pixi run fmt` and `pixi run lint-fix` apply the formatter and the safe lint fixes, and `pixi run hooks` installs the git hooks that run the same tools before each commit.
|
||||
The tests in `tests/` take their data from the vectors and fixtures, so a rule change that a vector or a fixture covers shows up in both the suite and `paperspec check`.
|
||||
|
||||
+1
-1
@@ -16,4 +16,4 @@ All text in the fixtures is synthetic, written for them.
|
||||
License fields inside fixtures describe fictional works, not the fixtures.
|
||||
The keys in `fixtures/keys/` are public test keys and must never sign anything else.
|
||||
|
||||
Copyright 2026 the Scientific Computing Studio.
|
||||
Copyright 2026 Scienting.
|
||||
@@ -59,7 +59,7 @@ The address grammar is in [spec/06 §6.1](spec/06-anchors.md#61-addresses), and
|
||||
The formats need no installation: they are files.
|
||||
The Python package `paperspec` needs Python 3.14 and, for the `paperspec` command, the `tools` extra (`jsonschema`, `referencing` and `cryptography`).
|
||||
|
||||
### From the studio's package registry
|
||||
### From Scienting's package registry
|
||||
|
||||
The registry does not mirror PyPI, so an installer needs two indexes: the registry for `paperspec`, and PyPI for the packages it depends on.
|
||||
Tie `paperspec` to the registry wherever the installer allows it, so that a package of the same name on PyPI is never chosen instead.
|
||||
@@ -216,7 +216,7 @@ Only `paperspec validate` and `paperspec load` work anywhere the package is inst
|
||||
The specification and other prose are CC BY 4.0, so anyone may implement the formats.
|
||||
Schemas, SQL, the JSON-LD context, the registries, the vectors and the fixtures are CC0 1.0.
|
||||
The code, the `paperspec` package in `src/` with its commands and its tests, is Apache-2.0, and its Python files open with an SPDX header that says so.
|
||||
This repository does not use the studio's Prosperity license, because the formats are meant to be implemented by anyone without asking.
|
||||
This repository does not use Scienting's usual Prosperity license, because the formats are meant to be implemented by anyone without asking.
|
||||
See [LICENSE.md](LICENSE.md).
|
||||
|
||||
## Credits
|
||||
@@ -230,4 +230,4 @@ The annotation layers build on the [W3C Web Annotation Data Model](https://www.w
|
||||
## Contributing
|
||||
|
||||
Propose a change as a pull request; [CONTRIBUTING.md](CONTRIBUTING.md) says what a change needs, from the chapter to the vectors.
|
||||
`[CHECK: the studio's contributor license agreement does not exist yet; CONTRIBUTING.md invites pull requests as it did before]`
|
||||
`[CHECK: Scienting's contributor license agreement does not exist yet; CONTRIBUTING.md invites pull requests as it did before]`
|
||||
@@ -32,5 +32,5 @@ Where an older guide, a doc comment or the `--help` text says something differen
|
||||
`check`, `build`, `stress` and `site` need a checkout of the repository.
|
||||
- `paperspec validate --correction` reports a proposals file that is not valid JSON with a Python traceback, not a one-line message.
|
||||
- The Python API has no generated reference yet: [the API page](../reference/api.md) is written by hand from the code's docstrings.
|
||||
- The package is not on the studio's registry until a version tag is pushed. `[CHECK: no tag exists yet]`
|
||||
- The package is not on Scienting's registry until a version tag is pushed. `[CHECK: no tag exists yet]`
|
||||
- Thirteen formats are `provisional` and may still change.
|
||||
@@ -1,6 +1,6 @@
|
||||
# License
|
||||
|
||||
paperspec is not under the studio's usual license.
|
||||
paperspec is not under Scienting's usual license.
|
||||
Because the formats are meant to be implemented by anyone, in any product, without asking, each path of the repository keeps the license that `LICENSE.md` gives it.
|
||||
|
||||
| Paths | License | SPDX |
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Two pages take you from nothing to a result.
|
||||
|
||||
1. [Install](install.md) the package from the studio's package registry, or work from a checkout.
|
||||
1. [Install](install.md) the package from Scienting's package registry, or work from a checkout.
|
||||
2. [Quick start](quick-start.md) validates the example paper and loads it into a database.
|
||||
|
||||
The package needs Python 3.14.
|
||||
|
||||
@@ -10,7 +10,7 @@ Three extras add what some modules need:
|
||||
| `crypto` | `cryptography` | Ed25519 signatures and HKDF in `crypto`, which the signature and receipt checks use |
|
||||
| `tools` | both of the above | the `paperspec` command, and any program that validates packages |
|
||||
|
||||
## From the studio's package registry
|
||||
## From Scienting's package registry
|
||||
|
||||
The registry does not mirror PyPI, so an installer needs two indexes: the registry for `paperspec`, and PyPI for `jsonschema`, `referencing` and `cryptography`.
|
||||
Tie `paperspec` to the registry wherever the installer allows it, so that a package of the same name on PyPI is never chosen instead.
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ A merge records its successor, a deletion records that there is none, and legacy
|
||||
A citation key such as `vaswani2017attention` is what readers say, and it collides: a preprint and its published version, or two papers by one first author in one year with the same first title word, would share it.
|
||||
Four characters of a hash of the work's identity, its DOI when it has one, settle the collision and let any tool holding the DOI recompute the key.
|
||||
The key is minted once and never recomputed, so a corrected title cannot change a name someone has cited; when two works still share four characters, the later one gets six ([spec/02 §2.4](../spec/02-model.md#24-work-and-document-keys)).
|
||||
The rule is the one the studio's reading-list tool already uses, so a paper keeps its key from the reading list to the store.
|
||||
The rule is the one Scienting's reading-list tool already uses, so a paper keeps its key from the reading list to the store.
|
||||
|
||||
### Identifiers are tag URIs
|
||||
|
||||
|
||||
+2
-2
@@ -1,7 +1,7 @@
|
||||
# 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 studio standard: setuptools with setuptools-scm instead of hatchling with hatch.toml.
|
||||
# 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.
|
||||
|
||||
@@ -17,7 +17,7 @@ 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" }]
|
||||
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"
|
||||
|
||||
+1
-1
@@ -7,7 +7,7 @@ site_description = "The Python package and the commands of paperspec, the refere
|
||||
site_url = "https://docs.scient.ing/paperspec/"
|
||||
repo_url = "https://git.scient.ing/papers/paperspec"
|
||||
repo_name = "papers/paperspec"
|
||||
copyright = "Scientific Computing Studio, LLC"
|
||||
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"
|
||||
|
||||
Reference in new issue
Block a user