sslabdata 3.1.0__tar.gz → 4.0.0__tar.gz

{sslabdata-3.1.0/sslabdata.egg-info → sslabdata-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sslabdata
-Version: 3.1.0
+Version: 4.0.0
 Summary: Renderer-agnostic academic lab data assembler: BibTeX + YAML → structured data
 Author: Siddhartha Srinivasa
 License-Expression: MIT
@@ -37,6 +37,11 @@ Dynamic: license-file
 
 # sslabdata
 
+[![PyPI](https://img.shields.io/pypi/v/sslabdata.svg)](https://pypi.org/project/sslabdata/)
+[![Python](https://img.shields.io/pypi/pyversions/sslabdata.svg)](https://pypi.org/project/sslabdata/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/siddhss5/sslabdata/blob/main/LICENSE)
+[![Tests](https://github.com/siddhss5/sslabdata/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/siddhss5/sslabdata/actions/workflows/test.yml)
+
 sslabdata compiles BibTeX and a little YAML into one schema-specified document —
 works, people, projects and the links between them — that any website, CV or
 script can read.
@@ -56,10 +61,11 @@ sslabdata --config lab.yaml --output lab.yml
   order the lists are in, which fields are derived, when the version changes.
 - [`CHANGELOG.md`](https://github.com/siddhss5/sslabdata/blob/main/CHANGELOG.md) — what changed at each release, and what it
   replaced.
-- [`schema/v5/output.schema.json`](https://github.com/siddhss5/sslabdata/blob/main/schema/v5/output.schema.json) — the
+- [`schema/v6/output.schema.json`](https://github.com/siddhss5/sslabdata/blob/main/schema/v6/output.schema.json) — the
   document's JSON Schema. Published versions are immutable and live at their
-  own paths; [`schema/v3/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v3/output.schema.json) and
-  [`schema/v4/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v4/output.schema.json) are still there.
+  own paths; [`schema/v3/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v3/output.schema.json),
+  [`schema/v4/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v4/output.schema.json) and
+  [`schema/v5/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v5/output.schema.json) are still there.
 - [`tests/COVERAGE.md`](https://github.com/siddhss5/sslabdata/blob/main/tests/COVERAGE.md) — every input case sslabdata
   supports, and every case it does not, with the fixture and test for each.
 
@@ -182,6 +188,7 @@ nothing else:
 | `doi`, `isbn`, `issn`, `eprint` + `archivePrefix` (or `eprinttype`) | `identifiers`, an open map from scheme to a list of identifiers, plus the links built from them. An `eprint`'s scheme is the repository `archivePrefix` or `eprinttype` named, lower-cased, so that field needs no property of its own — and an `eprint` in a repository other than arXiv gets no arXiv link |
 | `abstract` | `abstract` |
 | `note` | `note` |
+| `award` | `awards`, a list of `{name, year}` (see below). `note` is never read for awards |
 | `url` | A link of kind `video` when its host is YouTube or Vimeo (or a subdomain of either), otherwise of kind `url` |
 | `video` | A link of kind `video`, whatever its host, so `url` can hold the work's website |
 | `pdf` | The work's one link of kind `pdf`. An entry without it gets `pdf_base_url` plus its citation key, when `pdf_base_url` is set |
@@ -192,6 +199,26 @@ The entry is also re-serialized into a `bibtex` field, so fields sslabdata does
 not interpret are still carried. It is a re-serialization, not a copy
 ([`SPEC.md` §5](https://github.com/siddhss5/sslabdata/blob/main/SPEC.md#5-input-versus-derived)).
 
+### Awards
+
+A paper's awards go in its `award` field. Several are separated by `and`, as
+the names in `author` are, and braces keep an `and` inside one name. An award
+may start with the year it was given, as `YYYY:` and a space, when that is not
+the paper's year:
+
+```bibtex
+award = {2026: Test of Time Award and {Best Systems and Software Paper Award}}
+```
+
+Each award becomes `{name, year}` in the work's `awards`, in the order
+written, with its name converted from LaTeX as `title` is. An award without a
+year takes the work's `year`, or `null` when the work has none. `awards` is
+`[]` for a work with no `award` field. An empty award, or a prefix that looks
+like a year and is not four digits, a colon and a space, is reported
+(`BIB-AWARD-EMPTY`, `BIB-AWARD-YEAR-MALFORMED`); a malformed prefix stays in
+the name. Awards a person holds, such as fellowships, are not part of the
+document.
+
 ### The `project` tag
 
 sslabdata adds one custom BibTeX field, `project`, to link a paper to a research
@@ -205,6 +232,7 @@ project:
   year      = {2024},
   eprint    = {2406.99812},
   archivePrefix = {arXiv},
+  award     = {Best Paper Award},
   project   = {homebot}
 }
 ```
@@ -349,7 +377,7 @@ pip install jsonschema
 python -c "
 import json, yaml, jsonschema
 from importlib.resources import files
-schema = json.loads(files('sslabdata.schema').joinpath('v5/output.schema.json').read_text())
+schema = json.loads(files('sslabdata.schema').joinpath('v6/output.schema.json').read_text())
 jsonschema.Draft202012Validator(schema).validate(yaml.safe_load(open('lab.yml')))
 print('valid')
 "

{sslabdata-3.1.0 → sslabdata-4.0.0}/README.md

@@ -1,5 +1,10 @@
 # sslabdata
 
+[![PyPI](https://img.shields.io/pypi/v/sslabdata.svg)](https://pypi.org/project/sslabdata/)
+[![Python](https://img.shields.io/pypi/pyversions/sslabdata.svg)](https://pypi.org/project/sslabdata/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/siddhss5/sslabdata/blob/main/LICENSE)
+[![Tests](https://github.com/siddhss5/sslabdata/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/siddhss5/sslabdata/actions/workflows/test.yml)
+
 sslabdata compiles BibTeX and a little YAML into one schema-specified document —
 works, people, projects and the links between them — that any website, CV or
 script can read.
@@ -19,10 +24,11 @@ sslabdata --config lab.yaml --output lab.yml
   order the lists are in, which fields are derived, when the version changes.
 - [`CHANGELOG.md`](https://github.com/siddhss5/sslabdata/blob/main/CHANGELOG.md) — what changed at each release, and what it
   replaced.
-- [`schema/v5/output.schema.json`](https://github.com/siddhss5/sslabdata/blob/main/schema/v5/output.schema.json) — the
+- [`schema/v6/output.schema.json`](https://github.com/siddhss5/sslabdata/blob/main/schema/v6/output.schema.json) — the
   document's JSON Schema. Published versions are immutable and live at their
-  own paths; [`schema/v3/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v3/output.schema.json) and
-  [`schema/v4/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v4/output.schema.json) are still there.
+  own paths; [`schema/v3/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v3/output.schema.json),
+  [`schema/v4/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v4/output.schema.json) and
+  [`schema/v5/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v5/output.schema.json) are still there.
 - [`tests/COVERAGE.md`](https://github.com/siddhss5/sslabdata/blob/main/tests/COVERAGE.md) — every input case sslabdata
   supports, and every case it does not, with the fixture and test for each.
 
@@ -145,6 +151,7 @@ nothing else:
 | `doi`, `isbn`, `issn`, `eprint` + `archivePrefix` (or `eprinttype`) | `identifiers`, an open map from scheme to a list of identifiers, plus the links built from them. An `eprint`'s scheme is the repository `archivePrefix` or `eprinttype` named, lower-cased, so that field needs no property of its own — and an `eprint` in a repository other than arXiv gets no arXiv link |
 | `abstract` | `abstract` |
 | `note` | `note` |
+| `award` | `awards`, a list of `{name, year}` (see below). `note` is never read for awards |
 | `url` | A link of kind `video` when its host is YouTube or Vimeo (or a subdomain of either), otherwise of kind `url` |
 | `video` | A link of kind `video`, whatever its host, so `url` can hold the work's website |
 | `pdf` | The work's one link of kind `pdf`. An entry without it gets `pdf_base_url` plus its citation key, when `pdf_base_url` is set |
@@ -155,6 +162,26 @@ The entry is also re-serialized into a `bibtex` field, so fields sslabdata does
 not interpret are still carried. It is a re-serialization, not a copy
 ([`SPEC.md` §5](https://github.com/siddhss5/sslabdata/blob/main/SPEC.md#5-input-versus-derived)).
 
+### Awards
+
+A paper's awards go in its `award` field. Several are separated by `and`, as
+the names in `author` are, and braces keep an `and` inside one name. An award
+may start with the year it was given, as `YYYY:` and a space, when that is not
+the paper's year:
+
+```bibtex
+award = {2026: Test of Time Award and {Best Systems and Software Paper Award}}
+```
+
+Each award becomes `{name, year}` in the work's `awards`, in the order
+written, with its name converted from LaTeX as `title` is. An award without a
+year takes the work's `year`, or `null` when the work has none. `awards` is
+`[]` for a work with no `award` field. An empty award, or a prefix that looks
+like a year and is not four digits, a colon and a space, is reported
+(`BIB-AWARD-EMPTY`, `BIB-AWARD-YEAR-MALFORMED`); a malformed prefix stays in
+the name. Awards a person holds, such as fellowships, are not part of the
+document.
+
 ### The `project` tag
 
 sslabdata adds one custom BibTeX field, `project`, to link a paper to a research
@@ -168,6 +195,7 @@ project:
   year      = {2024},
   eprint    = {2406.99812},
   archivePrefix = {arXiv},
+  award     = {Best Paper Award},
   project   = {homebot}
 }
 ```
@@ -312,7 +340,7 @@ pip install jsonschema
 python -c "
 import json, yaml, jsonschema
 from importlib.resources import files
-schema = json.loads(files('sslabdata.schema').joinpath('v5/output.schema.json').read_text())
+schema = json.loads(files('sslabdata.schema').joinpath('v6/output.schema.json').read_text())
 jsonschema.Draft202012Validator(schema).validate(yaml.safe_load(open('lab.yml')))
 print('valid')
 "

{sslabdata-3.1.0 → sslabdata-4.0.0}/SPEC.md

@@ -7,7 +7,7 @@ them.
 This file states the parts of that contract a JSON Schema cannot express:
 what the strings in the document are, what order the lists are in, what an
 absent key means, which fields are computed, when the version changes, and
-how a repeated `@string` macro resolves. `schema/v5/output.schema.json`
+how a repeated `@string` macro resolves. `schema/v6/output.schema.json`
 states the rest.
 
 Everything here is normative unless it carries a `Target` note. A `Target`
@@ -16,8 +16,8 @@ names the issue that will make it true. Until that issue lands, the rule is
 the intent and the note is the fact. What changed at each release, and what
 it replaced, is in [`CHANGELOG.md`](CHANGELOG.md), not here.
 
-- Applies to: `schema_version` 5 (`sslabdata.models.SCHEMA_VERSION`), package
-  version 3.0.0 (`sslabdata.__version__`).
+- Applies to: `schema_version` 6 (`sslabdata.models.SCHEMA_VERSION`), package
+  version 4.0.0 (`sslabdata.__version__`).
 
 ### How this file cites the code
 
@@ -25,7 +25,7 @@ Every rule below is grounded in a named part of the code rather than a line
 number, because line numbers rot silently: a function such as
 `sslabdata.parsers.bibtex.parse_all_works()`, a method such as
 `Person.to_dict()`, a module-level constant such as `TEXT_FIELDS`, a JSON
-Pointer into `schema/v5/output.schema.json` such as `/$defs/person/required`, or
+Pointer into `schema/v6/output.schema.json` such as `/$defs/person/required`, or
 a `tests/COVERAGE.md` row key such as `config.people_file.missing`. A bare
 statement is cited by its enclosing function.
 
@@ -201,7 +201,7 @@ without depending on English wording. Codes obey three rules:
    | **Fatal at load** | `Error loading configuration: <CODE> …` (`Error: <CODE> …` for `CONFIG-NOT-FOUND`) on standard error; exits `1` before anything is compiled, so there is no report. | The same. | `CONFIG-BIB-FILE-ABSOLUTE`, `CONFIG-BIB-FILE-OUTSIDE-BIB-DIR`, `CONFIG-NOT-A-MAPPING`, `CONFIG-KEY-MISSING`, `CONFIG-TYPE-INVALID`, `CONFIG-VALUE-NOT-JSON`, `CONFIG-KEY-REPEATED`, `CONFIG-NOT-FOUND`, `CONFIG-UNREADABLE` |
    | **Fatal** | Listed under `Bibliography errors` and counted; exits `1`. | Written to standard error unprefixed; exits `1`, and `--output` writes nothing. | `BIB-CROSSREF-UNSUPPORTED`, `BIB-ENCODING-INVALID`, `CONFIG-FILE-NOT-FOUND`, `CONFIG-PATH-WRONG-KIND`, `PEOPLE-YAML-INVALID`, `PEOPLE-NOT-A-LIST`, `PEOPLE-FIELD-MISSING`, `PROJECTS-YAML-INVALID`, `PROJECTS-NOT-A-LIST`, `PROJECTS-FIELD-MISSING`, `COLLABORATORS-YAML-INVALID`, `COLLABORATORS-NOT-A-LIST`, `COLLABORATORS-FIELD-MISSING`, `RECORD-KEY-REPEATED`, `OUTPUT-WRITE-FAILED`, `INIT-FILE-EXISTS`, `INIT-PATH-WRONG-KIND`, `INIT-PATH-OUTSIDE-DIR`, `INIT-WRITE-FAILED` |
    | **Validation error** | Listed under `Bibliography errors` and counted; exits `1`. | Prefixed `Warning: ` on standard error; the run continues and exits `0`. | `BIB-DUPLICATE-KEY`, `RESOLVE-PROJECT-UNKNOWN`, `PEOPLE-ID-DUPLICATE`, `PROJECTS-ID-DUPLICATE` |
-   | **Warning** | Listed under `Warnings`; not counted, and does not change the exit code. | Prefixed `Warning: ` on standard error; the run continues. | `BIB-YEAR-MISSING`, `BIB-YEAR-INVALID`, `BIB-DOI-INVALID`, `BIB-OTHERS-NOT-LAST`, `BIB-STRING-UNDEFINED`, `BIB-SYNTAX-ERROR`, `BIB-BRACE-MISMATCH`, `BIB-COMMENTED-COMMAND-READ`, `BIB-VENUE-MISSING`, `BIB-ENTRY-TYPE-UNSUPPORTED`, `LATEX-COMMAND-UNKNOWN`, `ID-GROUPING-SPANS-SPELLINGS`, `ID-GROUPING-INITIALS-AMBIGUOUS`, `RESOLVE-AMBIGUOUS-NAME`, `RESOLVE-SUGGESTION`, `RESOLVE-COLLABORATOR-ALIAS-IS-MEMBER`, `PEOPLE-ALIAS-AMBIGUOUS`, `PEOPLE-ROLE-INVALID`, `PEOPLE-STATUS-INVALID`, `PROJECTS-STATUS-INVALID`, `CONFIG-LAB-NAME-MISSING`, `CONFIG-KEY-UNKNOWN`, `RECORD-KEY-UNKNOWN`, `RECORD-TYPE-INVALID`, `CONFIG-BIB-FILES-MISSING`, `BIB-PARSER-MESSAGE`, `LATEX-CONVERSION-FAILED`, `LINK-SCHEME-UNSUPPORTED`, `TEXT-CONTROL-CHARACTER`, `BIB-WRITE-BACK-FAILED`, `BIB-STRING-REDEFINED`, `ID-GROUPING-AMBIGUOUS-DECLARED`, `RESOLVE-UNRESOLVED-NAME` |
+   | **Warning** | Listed under `Warnings`; not counted, and does not change the exit code. | Prefixed `Warning: ` on standard error; the run continues. | `BIB-YEAR-MISSING`, `BIB-YEAR-INVALID`, `BIB-DOI-INVALID`, `BIB-AWARD-EMPTY`, `BIB-AWARD-YEAR-MALFORMED`, `BIB-OTHERS-NOT-LAST`, `BIB-STRING-UNDEFINED`, `BIB-SYNTAX-ERROR`, `BIB-BRACE-MISMATCH`, `BIB-COMMENTED-COMMAND-READ`, `BIB-VENUE-MISSING`, `BIB-ENTRY-TYPE-UNSUPPORTED`, `LATEX-COMMAND-UNKNOWN`, `ID-GROUPING-SPANS-SPELLINGS`, `ID-GROUPING-INITIALS-AMBIGUOUS`, `RESOLVE-AMBIGUOUS-NAME`, `RESOLVE-SUGGESTION`, `RESOLVE-COLLABORATOR-ALIAS-IS-MEMBER`, `PEOPLE-ALIAS-AMBIGUOUS`, `PEOPLE-ROLE-INVALID`, `PEOPLE-STATUS-INVALID`, `PROJECTS-STATUS-INVALID`, `CONFIG-LAB-NAME-MISSING`, `CONFIG-KEY-UNKNOWN`, `RECORD-KEY-UNKNOWN`, `RECORD-TYPE-INVALID`, `CONFIG-BIB-FILES-MISSING`, `BIB-PARSER-MESSAGE`, `LATEX-CONVERSION-FAILED`, `LINK-SCHEME-UNSUPPORTED`, `TEXT-CONTROL-CHARACTER`, `BIB-WRITE-BACK-FAILED`, `BIB-STRING-REDEFINED`, `ID-GROUPING-AMBIGUOUS-DECLARED`, `RESOLVE-UNRESOLVED-NAME` |
 
    The same code always carries the same class. What varies with the mode is
    how the run reacts to it, which is why the class is not in the code, and
@@ -249,6 +249,8 @@ Codes in use:
 | `CONFIG-LAB-NAME-MISSING` | The `lab` header declares no `name`. A `lab` that is not a mapping at all is a different condition and is not reported under this code. A warning. |
 | `BIB-YEAR-INVALID` | An entry's `year` is present but is not an unsigned run of the ASCII digits `0`–`9` (`sslabdata.parsers.bibtex.YEAR_DIGITS`), such as `in press`, or `-5`, `+2020`, `2_020` and full-width `２０２０`, which Python's `int()` would read as numbers. The work is emitted with `year: null` and sorts last, as one with no year does. A warning. |
 | `BIB-DOI-INVALID` | An entry's `doi` is a DOI resolver URL with nothing after it, such as `https://doi.org/` (`sslabdata.parsers.bibtex.DOI_RESOLVERS`), so it names no DOI. Located at `<file>:<key>:doi`, naming the value. The work gets no DOI identifier and no link of kind `doi`, rather than an empty one; the entry is kept. A `doi` that is empty or blank is read as absent, and is not reported. A warning. |
+| `BIB-AWARD-EMPTY` | An entry's `award` field names no award: the field is empty or whitespace alone, or one of its awards is empty — two `and`s with nothing between them, an `and` that opens or closes the list, or a name that is empty once converted from LaTeX, such as `{}` — or is a year prefix with no name after it, such as `2026:` (`sslabdata.parsers.bibtex.parse_awards()`). Located at `<file>:<key>:award`; the prose names the award's place in the list, and the award as written when it has a year. The empty award is dropped and the others are kept, so an empty field gives `awards: []`. A warning. |
+| `BIB-AWARD-YEAR-MALFORMED` | An award in an entry's `award` field starts with what reads as a year but is not the prefix `YYYY:` — four ASCII digits, a colon and whitespace (`sslabdata.parsers.bibtex.AWARD_YEAR`): digits of any kind and a colon, such as `26: …`, `2026:…` with no space, or full-width `２０２６: …`, or four digits and a space with no colon, `2026 …` (`AWARD_YEAR_LIKE`). Located at `<file>:<key>:award`, naming the award as written and the part that is not a prefix. No year is read from it: **the text is kept as part of the name**, and the award takes the work's `year`. A prefix inside braces, `{2026}: …`, is text the author protected and is not reported. A warning. |
 | `LINK-SCHEME-UNSUPPORTED` | A link in `work.links` whose URL scheme is not `http`, `https` or `mailto` (`sslabdata.parsers.bibtex.LINK_SCHEMES`), such as `javascript:`, `data:` or `vbscript:`, which a renderer escaping the document (§2) should refuse to turn into a link. The scheme is the one Python's URL parser reads (`urllib.parse.urlsplit()`, in `sslabdata.parsers.bibtex.url_scheme()`) once surrounding whitespace is off, compared without regard to case; the parser drops a tab or line break anywhere in the URL first, as a browser does, so `java<tab>script:` is `javascript`. A URL with no scheme is a relative path and is not reported; that includes a protocol-relative `//host/path`, which takes the scheme of the page that links it. A scheme of one letter is a Windows drive, read by Windows rules as `sslabdata.config` reads one (`PureWindowsPath`), and not a scheme: `C:/papers`, `C:\papers` and the drive-relative `c:papers` are local paths and are not reported. No registered scheme is one letter long. Every link is checked, whether the entry wrote it (`url`, `video`, `pdf`) or sslabdata built it (`doi`, `arxiv`, and `pdf` from `pdf_base_url`). Located at `<file>:<key>:<field>`, the field the link came from, or at `<file>:<key>:` for the PDF link `pdf_base_url` builds, which no field of the entry wrote; the prose names the link's kind, which for `url` can be `video`, and the URL. Once per link. A person's `website` and `photo`, a project's `website` and `image`, and everything under `lab` are fields, not links, and are not checked. **The link is emitted unchanged**: this code only reports it. A warning. |
 | `BIB-OTHERS-NOT-LAST` | An `author` or `editor` list has `and others` somewhere other than at its end, the one place BibTeX reads it as "et al.". It names nobody there either, so it is dropped as a terminal one is, and the names around it are kept in their order, with `position` counting only them. Located at `<file>:<key>:author` or `:editor`, once per list however many times it occurs. A terminal `and others` is not reported. A warning. |
 | `BIB-STRING-UNDEFINED` | A field value names an `@string` macro that nothing defined earlier in the same file. Located at the entry and field that use it, and naming the macro. It is read as empty, as BibTeX reads it, and the entry and its neighbours are kept. A macro used inside another `@string` definition is located at the file alone. A warning. |
@@ -359,7 +361,7 @@ What each mode puts in the array:
 
 **The Python API is convenience only.** Public: the names in `sslabdata.__all__`
 — `assemble`, `AssemblyResult`, `AssemblyError`, the models `LabData`,
-`Work`, `Author`, `Contributor`, `Venue`, `Link`, `Person`, `Project`,
+`Work`, `Award`, `Author`, `Contributor`, `Venue`, `Link`, `Person`, `Project`,
 `Collaborator`, the config loader `LabDataConfig` with `BibFile`, and the exporters
 `export_to_yaml` and `export_to_json`, and the exception
 `ConfigurationError`.
@@ -521,7 +523,8 @@ the URL, and in math it is escaped to `\&` or `\%`. Exactly the fields in
 `publisher`, `address`, `organization`, `archivePrefix` and `eprinttype` —
 applied in `entry_fields()`. Name
 parts are converted the same way, in `person_name_parts()`, for authors and
-editors alike.
+editors alike, and so is each award's name, once `award` is split into its
+awards and each award's year prefix is read (`parse_awards()`).
 
 Being converted is not the same as being emitted. Of these fields, `title`,
 `abstract`, `note`, `type`, `series`, `publisher`, `address` and
@@ -581,6 +584,7 @@ rule does not apply to the input itself — only to whatever it produces.
 | `pdf` | Becomes the work's one link of kind `pdf`, with `origin: input`, in place of the one `pdf_base_url` would give (`build_links()`). Empty or whitespace-only is read as absent. |
 | `author` | Parsed into the `authors` list (`parse_author_list()`); the name parts are converted under heading 1. |
 | `editor` | Parsed into the `editors` list (`parse_editor_list()`), resolved by the same machinery, and excluded from `person.work_ids`, from a project's people and from `collaborators`. |
+| `award` | Parsed into the `awards` list (`parse_awards()`), and emitted nowhere else: `note` is never read for awards, and an award in `note` stays there as text. The field is split into awards as BibTeX splits `author` into names: on `and`, in any case, with whitespace on both sides, outside braces, which are counted as BibTeX counts them, so `{Systems and Software Award}` is one award. An `and` that opens or closes the list, or follows another, separates an empty award, which is dropped and reported (`BIB-AWARD-EMPTY`). Each award may then start with the year it was given, four ASCII digits, a colon and whitespace, `2026: Test of Time Award` (`AWARD_YEAR`), read before the name is converted from LaTeX under heading 1 and trimmed; it is that award's `year`, which need not be the work's. An award without one takes the work's `year`, or `null` when the work has none. A prefix that reads as a year and is not one, `26:` or `2026 …`, is kept in the name and reported (`BIB-AWARD-YEAR-MALFORMED`). |
 | `year` | Emitted as the integer `year` — not a string — or `null` with a `BIB-YEAR-MISSING` diagnostic when the entry supplied none, or with `BIB-YEAR-INVALID` when it is not written in the digits `0`–`9` alone. It drives the works order (§3). |
 | `crossref` | **Rejected, on presence rather than on value.** An entry carrying the field is an error under `BIB-CROSSREF-UNSUPPORTED`, whatever is inside it: an empty `crossref = {}` is a field the entry carries, and letting it through would put the silent path back under a different spelling. The entry is not emitted and the run fails in every mode (`parse_all_works()`). No field of any entry is filled in from any other entry. |
 | `journal`, `booktitle`, `school`, `institution` | Converted under heading 1, then consumed by `build_venue()` into `venue.name`, with the `venue.kind` each implies. |
@@ -657,6 +661,7 @@ accident.
 | `works` | `year` **descending**, with works that have no year **last**. Ties keep *read order* (below). The sort is the final statement of `sslabdata.parsers.bibtex.parse_all_works()`. |
 | `work.authors` | The order the `author` field wrote them (`sslabdata.parsers.bibtex.parse_author_list()`). A terminal `and others` is BibTeX's "et al." and is dropped rather than emitted as an author; one anywhere else is dropped too, and reported as `BIB-OTHERS-NOT-LAST`. `position` is that order, 1-based, and counts only the names that reach the document. |
 | `work.editors` | The order the `editor` field wrote them, read the same way (`parse_editor_list()`). |
+| `work.awards` | The order the `award` field wrote them, with each empty award dropped (`parse_awards()`). |
 | `work.project_ids` | The order the `project` field wrote them, comma-separated, whitespace trimmed, empty entries dropped (`sslabdata.parsers.bibtex.parse_project_ids()`). |
 | `people` | The order of `people_file`. sslabdata does not sort people (`sslabdata.loaders.load_people()`, called by `sslabdata.assembler.assemble()`). |
 | `projects` | The order of `projects_file`, likewise (`sslabdata.loaders.load_projects()`). |
@@ -752,7 +757,7 @@ unconditionally, and by `LabData.to_dict()`, which always emits `lab`.
 itself and each entity type as **closed**: `/additionalProperties` and each
 of `/$defs/authorship`, `/$defs/editorship`, `/$defs/work`, `/$defs/person`,
 `/$defs/project`, `/$defs/collaborator`, `/$defs/venue`, `/$defs/link`,
-`/$defs/resolution`, and the `source` and `generator` objects, set
+`/$defs/resolution`, `/$defs/award`, and the `source` and `generator` objects, set
 `additionalProperties: false`. Within those, a property that is not declared
 cannot appear, and "absent" always means a declared property with no value.
 
@@ -783,6 +788,7 @@ sslabdata's own output as input, and a wrong derivation becomes permanent.
 | `work.source.file` | Input — the `name` of the `bib_files` entry the file was listed under, **never an absolute path**. A *relative* directory is fine and is passed through as written: `sub/journal.bib` is a name under `bib_dir`; one that leaves `bib_dir` is rejected under `CONFIG-BIB-FILE-OUTSIDE-BIB-DIR`. The guarantee is kept by rejecting the input rather than by rewriting it, which would quietly discard that directory, and is enforced under `CONFIG-BIB-FILE-ABSOLUTE` (§1, *`sslabdata.ConfigurationError`*). |
 | `work.entry_type` | Input — the BibTeX entry type, **lowercased** by `entry_fields()`. Of it and `bib_id`, it is the only one that is case-folded. |
 | `work.title`, `abstract`, `note` | Input — BibTeX fields, converted from LaTeX to text (§2). `note` additionally has trailing `.` and whitespace trimmed (`sslabdata.parsers.bibtex.extract_note()`). |
+| `work.awards` | Input — the BibTeX `award` field, split into awards, each `{name, year}`: `name` converted from LaTeX, and `year` the year the award was given, from its `YYYY:` prefix, else the work's `year`, else `null` (`sslabdata.parsers.bibtex.parse_awards()`, §2). `[]` when the entry writes none. These are a work's awards only; an award a person holds, such as a fellowship, is not in the document. |
 | `work.year` | Input — the BibTeX `year`, as an integer; `null` when the entry supplied none, with a diagnostic (`entry_year()`). |
 | `work.category` | Input — the `category` of the `bib_files` entry the file was listed under, not anything in the `.bib` file (`sslabdata.config.BibFile`, read by `parse_all_works()`). |
 | `work.venue` | **Derived** — the first of `journal`, `booktitle`, `school` and `institution` the entry wrote, as `name`, with the `kind` that field and the entry type imply; a preprint's repository when the entry has only an `eprint`; `null` when it names no container (`sslabdata.parsers.bibtex.build_venue()`). See below. |
@@ -1114,13 +1120,14 @@ meaning and guarantees, and each of them is a bump.
 has been published is never edited. Version `N`'s schema stays reachable, byte
 for byte, at its own path after version `N+1` ships, so a consumer pinned to
 `N` keeps a stable target. `schema/v3/output.schema.json`,
-`schema/v4/output.schema.json` and `schema/v5/output.schema.json` are those
-paths, and `tests/COVERAGE.md` row `output.versioned_schema` asserts that the
-older two are unchanged byte for byte and still say `3` and `4`.
-
-**The `$id` is a pinned tag URL.** v5's `$id` is
-`https://raw.githubusercontent.com/siddhss5/sslabdata/schema-v5/schema/v5/output.schema.json`.
-The rule that makes it a contract rather than a guess: **the `schema-v5` tag
+`schema/v4/output.schema.json`, `schema/v5/output.schema.json` and
+`schema/v6/output.schema.json` are those paths, and `tests/COVERAGE.md` row
+`output.versioned_schema` asserts that the older three are unchanged byte for
+byte and still say `3`, `4` and `5`.
+
+**The `$id` is a pinned tag URL.** v6's `$id` is
+`https://raw.githubusercontent.com/siddhss5/sslabdata/schema-v6/schema/v6/output.schema.json`.
+The rule that makes it a contract rather than a guess: **the `schema-v6` tag
 is created when this version ships and is never moved.** A branch URL such as
 `blob/main` is not usable — it serves an HTML page rather than the schema, so
 no consumer can ever have resolved v3's `$id` — and this repository publishes
@@ -1135,8 +1142,8 @@ rule.
 descriptions inside those files, name the repository `labdata`, and the files
 are left byte for byte as published rather than rewritten. v4's raw `$id`
 resolves, because GitHub redirects `labdata` to `sslabdata`. v3's `blob/main`
-`$id` does not resolve, as above. v5's `$id`, title and descriptions say
-`sslabdata`.
+`$id` does not resolve, as above. The `$id`s, titles and descriptions of v5
+and v6 say `sslabdata`.
 
 **The input schemas are versioned apart from the document.**
 `schema/input/v1/` holds a JSON Schema for each input file: `lab.schema.json`,
@@ -1243,7 +1250,7 @@ So each rejected type is rejected for a stated reason, and each has a home:
 | Teaching and courses | A prose page in your site repository, or the institution's course catalogue. |
 | Press and media coverage | A typed link on the work it covers: `links` is an open map from kind to links, so #27 adds the kind without a version bump. |
 | Galleries, photos and videos | Your site repository; a video already reaches the document as a link of kind `video`. |
-| Awards and honours | An attribute of the work, today `work.note`; #27 moves it out of `note`. |
+| Awards and honours | A paper's awards are an attribute of the work, `work.awards`, read from its `award` field (§5). An award a person holds, such as a fellowship or an endowed chair, belongs in your site repository. |
 | Funding and grants | Your site repository. Nothing in the document depends on it. |
 | Software and datasets | Not a separate collection — they are kinds of *work*, added by #31. |
 | Alumni | Not a collection — a `status` on a person (`sslabdata.models.Person.status`). |
@@ -1260,7 +1267,7 @@ vocabularies, not over arbitrary content.
 
 ## 9. What this file is not
 
-It does not list the document's fields; `schema/v5/output.schema.json` does.
+It does not list the document's fields; `schema/v6/output.schema.json` does.
 It does not describe renderers such as
 [sslabdata-site](https://github.com/siddhss5/sslabdata-site), which are
 downstream consumers in their own repositories. It does not describe the input formats `lab.yaml`,

{sslabdata-3.1.0 → sslabdata-4.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sslabdata"
-version = "3.1.0"
+version = "4.0.0"
 description = "Renderer-agnostic academic lab data assembler: BibTeX + YAML → structured data"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -58,7 +58,7 @@ requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 # The current output schema and input schemas are public wheel data, installed
-# at sslabdata/schema/v5/output.schema.json and
+# at sslabdata/schema/v6/output.schema.json and
 # sslabdata/schema/input/v1/*.schema.json. The package directory is mapped onto
 # the repository's schema/ directory so each frozen file has one copy and one
 # path; earlier versions stay in the sdist only. schema/__init__.py makes the
@@ -71,7 +71,7 @@ packages = ["sslabdata", "sslabdata.parsers", "sslabdata.schema"]
 "sslabdata.schema" = "schema"
 
 [tool.setuptools.package-data]
-"sslabdata.schema" = ["v5/output.schema.json", "input/v1/*.schema.json"]
+"sslabdata.schema" = ["v6/output.schema.json", "input/v1/*.schema.json"]
 # The starting point `sslabdata init` copies.
 "sslabdata" = ["templates/init/*.yaml", "templates/init/bib/*.bib"]
 

sslabdata-4.0.0/schema/v6/output.schema.json

@@ -0,0 +1,481 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/siddhss5/sslabdata/schema-v6/schema/v6/output.schema.json",
+  "title": "sslabdata output",
+  "description": "The lab.yml / lab.json file written by `sslabdata --output`. YAML and JSON exports hold the same data. Published schemas are immutable: this one is served from the `schema-v6` tag, which is created when this version ships and is never moved.",
+  "type": "object",
+  "required": [
+    "schema_version", "generator", "lab", "works", "people", "projects",
+    "collaborators"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "schema_version": {
+      "description": "Version of this output format. Bumped when a change could break a consumer.",
+      "const": 6
+    },
+    "generator": {
+      "description": "What compiled this document. It carries no timestamp: a build timestamp would make every run differ, and git records when.",
+      "type": "object",
+      "required": ["name", "version", "schema_version"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "version": {
+          "description": "The sslabdata package version. Independent of schema_version; neither can be derived from the other.",
+          "type": "string",
+          "minLength": 1
+        },
+        "schema_version": { "const": 6 }
+      }
+    },
+    "lab": {
+      "description": "The lab section of lab.yaml, copied through unchanged and always emitted, so an empty header is distinguishable from no header. The properties below are declared for documentation only: this object stays open, and a consumer must probe for the keys it wants rather than expect a fixed set.",
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "name": { "type": "string" },
+        "description": { "type": "string" },
+        "institution": { "type": "string" },
+        "department": { "type": "string" },
+        "website": { "type": "string" },
+        "email": { "type": "string" },
+        "address": { "type": "string" },
+        "logo": { "type": "string" },
+        "links": { "type": "object" }
+      }
+    },
+    "works": {
+      "description": "Everything the lab produced that carries a citation key. Ordered by year descending, works with no year last; ties keep read order.",
+      "type": "array",
+      "items": { "$ref": "#/$defs/work" }
+    },
+    "people": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/person" }
+    },
+    "projects": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/project" }
+    },
+    "collaborators": {
+      "description": "A derived grouping over the authorships that resolved to nobody in people.yaml. Not a list of people: see /$defs/collaborator.",
+      "type": "array",
+      "items": { "$ref": "#/$defs/collaborator" }
+    }
+  },
+  "$defs": {
+    "optionalString": { "type": ["string", "null"] },
+    "idList": {
+      "type": "array",
+      "items": { "type": "string", "minLength": 1 }
+    },
+    "derived": {
+      "description": "Reserved for sslabdata. Every key inside it is sslabdata's; consumers tolerate keys they do not know and must not write their own. A key graduating out of it into a named property is still a major change. It is not a general extension mechanism.",
+      "type": "object",
+      "additionalProperties": true
+    },
+    "venue": {
+      "description": "Where a work appeared. The one place sslabdata normalises across entry types, collapsing `journal`, `booktitle`, `school` and `institution` to one name plus a kind.",
+      "type": "object",
+      "required": ["kind", "name"],
+      "additionalProperties": false,
+      "properties": {
+        "kind": {
+          "description": "An open string, deliberately not an enum so that new work types need no version bump. Documented values: `journal`, `conference`, `book`, `institution`, `repository`, `other`.",
+          "type": "string",
+          "minLength": 1
+        },
+        "name": { "type": "string", "minLength": 1 }
+      }
+    },
+    "link": {
+      "description": "One URL a work can be reached at. A link that fails verification is kept and labelled, never deleted, so a consumer can tell a broken link from an absent one.",
+      "type": "object",
+      "required": ["url", "label", "origin", "verification"],
+      "additionalProperties": false,
+      "properties": {
+        "url": { "type": "string", "minLength": 1 },
+        "label": { "$ref": "#/$defs/optionalString" },
+        "origin": {
+          "description": "Where the link came from. An open string; documented values are `input` (the entry's own field), `sidecar`, `enrichment`, `inferred` and `derived` (sslabdata built it). Only `input` means the entry supplied it.",
+          "type": "string",
+          "minLength": 1
+        },
+        "verification": {
+          "type": "object",
+          "required": ["status"],
+          "additionalProperties": false,
+          "properties": {
+            "status": {
+              "description": "`unchecked` when nothing has looked, `verified` when a local filesystem check or a committed cache found it, `missing` when one looked and it was not there. A build never fetches.",
+              "enum": ["unchecked", "verified", "missing"]
+            }
+          }
+        }
+      }
+    },
+    "linkMap": {
+      "description": "An open map from link kind to a list of links, so that two code repositories or two videos can both be carried. Documented kinds: `pdf`, `doi`, `arxiv`, `url`, `video`. Unordered; consumers filter.",
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "items": { "$ref": "#/$defs/link" }
+      }
+    },
+    "identifierMap": {
+      "description": "An open map from identifier scheme to a unique list of identifiers, for example {\"doi\": [\"10.5555/...\"], \"arxiv\": [\"2501.01234\"]}. Schemes are documented, not enumerated. A list because ISBN and ISSN genuinely repeat. Unordered; consumers filter.",
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "items": { "type": "string", "minLength": 1 },
+        "uniqueItems": true
+      }
+    },
+    "resolution": {
+      "description": "Whether this contributor was matched to a person, and how. Both are open strings: #24 adds `ambiguous` to the status and #25 fills the method with an override or an ORCID, and neither is breaking.",
+      "type": "object",
+      "required": ["status", "method"],
+      "additionalProperties": false,
+      "properties": {
+        "status": {
+          "description": "Documented values: `resolved`, `unresolved`.",
+          "type": "string",
+          "minLength": 1
+        },
+        "method": {
+          "description": "Documented values: `exact`, `fuzzy`, or null when nothing matched.",
+          "$ref": "#/$defs/optionalString"
+        }
+      }
+    },
+    "nameParts": {
+      "description": "The name properties every contributor record carries: the readable form, the parts BibTeX split it into, its position in the list, the person it resolved to, and how. Referenced in place, so each record below still declares every key it allows -- `additionalProperties: false` sees only its own `properties`.",
+      "type": "object",
+      "required": [
+        "name", "position", "person_id", "given", "von", "family", "suffix",
+        "literal", "resolution", "derived"
+      ],
+      "properties": {
+        "name": {
+          "description": "The structured parts joined in reading order. A readable form of the input name, not a citation form: it does not abbreviate, expand or normalise.",
+          "type": "string",
+          "minLength": 1
+        },
+        "position": {
+          "description": "1-based position in this work's list. With the work's bib_id it addresses the record.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "person_id": {
+          "description": "The id of the matching person in people.yaml, or null. It means nothing else.",
+          "type": ["string", "null"]
+        },
+        "given": {
+          "description": "Given and middle names, as the entry supplied them: an entry writing `Brown, B.` yields `B.`, which is correct rather than a gap. Null for a name written as one brace-protected unit.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "von": {
+          "description": "Surname particles such as `van den`. Null when the name has none.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "family": {
+          "description": "The surname, without particles or suffix. Null for a name written as one brace-protected unit.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "suffix": {
+          "description": "A lineage suffix such as `Jr.`. Null when the name has none.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "literal": {
+          "description": "A name written as one brace-protected unit, such as `{Example Robotics Consortium}`. Null for a parsed name, where the four parts above apply instead. Brace protection means `do not parse this`, so it does not assert that the name is an organisation.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "resolution": { "$ref": "#/$defs/resolution" },
+        "derived": { "$ref": "#/$defs/derived" }
+      }
+    },
+    "authorship": {
+      "description": "One authorship of a work, addressed by (work.bib_id, position). The authorship is the primary contributor record, so two people who write their names identically are never merged at this level. It references exactly one contributor: `person_id` for a person in people.yaml, `collaborator_key` for the grouping an unresolved authorship fell into.",
+      "$ref": "#/$defs/nameParts",
+      "type": "object",
+      "required": ["collaborator_key", "equal_contribution"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string" },
+        "position": { "type": "integer" },
+        "person_id": { "type": ["string", "null"] },
+        "given": { "$ref": "#/$defs/optionalString" },
+        "von": { "$ref": "#/$defs/optionalString" },
+        "family": { "$ref": "#/$defs/optionalString" },
+        "suffix": { "$ref": "#/$defs/optionalString" },
+        "literal": { "$ref": "#/$defs/optionalString" },
+        "resolution": { "$ref": "#/$defs/resolution" },
+        "derived": { "$ref": "#/$defs/derived" },
+        "collaborator_key": {
+          "description": "The key of the collaborator grouping this authorship fell into, or null when it resolved to a person.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "equal_contribution": {
+          "description": "True when the BibTeX entry marked this author with a `*`. The marker itself is not part of the name.",
+          "type": "boolean"
+        }
+      },
+      "oneOf": [
+        {
+          "properties": {
+            "person_id": { "type": "string", "minLength": 1 },
+            "collaborator_key": { "type": "null" }
+          }
+        },
+        {
+          "properties": {
+            "person_id": { "type": "null" },
+            "collaborator_key": { "type": "string", "minLength": 1 }
+          }
+        }
+      ]
+    },
+    "editorship": {
+      "description": "One editor of a work. Editing a volume is not an authorship: an editor is excluded from person.work_ids, from a project's people and from collaborators, so one that matched nobody is simply `person_id: null` and references no grouping.",
+      "$ref": "#/$defs/nameParts",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string" },
+        "position": { "type": "integer" },
+        "person_id": { "type": ["string", "null"] },
+        "given": { "$ref": "#/$defs/optionalString" },
+        "von": { "$ref": "#/$defs/optionalString" },
+        "family": { "$ref": "#/$defs/optionalString" },
+        "suffix": { "$ref": "#/$defs/optionalString" },
+        "literal": { "$ref": "#/$defs/optionalString" },
+        "resolution": { "$ref": "#/$defs/resolution" },
+        "derived": { "$ref": "#/$defs/derived" }
+      }
+    },
+    "award": {
+      "description": "One award a work received.",
+      "type": "object",
+      "required": ["name", "year"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "description": "The award's name, as plain text.",
+          "type": "string",
+          "minLength": 1
+        },
+        "year": {
+          "description": "The year the award was given, which need not be the work's: the year its `YYYY:` prefix wrote, else the work's `year`, else null.",
+          "type": ["integer", "null"],
+          "minimum": 0
+        }
+      }
+    },
+    "work": {
+      "type": "object",
+      "required": [
+        "bib_id", "source", "title", "authors", "editors", "year", "venue",
+        "volume", "number", "pages", "series", "edition", "publisher",
+        "address", "organization", "chapter", "month", "howpublished", "type",
+        "category", "entry_type", "abstract", "note", "awards", "identifiers",
+        "links", "project_ids", "bibtex", "derived"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "bib_id": {
+          "description": "The BibTeX citation key, as written.",
+          "type": "string",
+          "minLength": 1
+        },
+        "source": {
+          "description": "Where this work was read from. Per-field provenance stays out of the document; #30 uses `derived`.",
+          "type": "object",
+          "required": ["file", "key"],
+          "additionalProperties": false,
+          "properties": {
+            "file": {
+              "description": "The configured `bib_files[].name`, never an absolute path.",
+              "type": "string"
+            },
+            "key": {
+              "description": "The citation key as written, which is `bib_id` again.",
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        "title": { "type": "string" },
+        "authors": { "type": "array", "items": { "$ref": "#/$defs/authorship" } },
+        "editors": { "type": "array", "items": { "$ref": "#/$defs/editorship" } },
+        "year": {
+          "description": "Null when the entry supplied none, which is reported as a diagnostic. A work with no year sorts last.",
+          "type": ["integer", "null"],
+          "minimum": 0
+        },
+        "venue": {
+          "description": "The container this work appeared in, or null when the entry names none.",
+          "oneOf": [{ "$ref": "#/$defs/venue" }, { "type": "null" }]
+        },
+        "volume": { "$ref": "#/$defs/optionalString" },
+        "number": {
+          "description": "BibTeX's `number`, with BibTeX's meaning: an issue number for an article and a report number for a technical report. Reinterpreting it is not sslabdata's job; `venue.kind` gives a consumer the branch it needs.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "pages": { "$ref": "#/$defs/optionalString" },
+        "series": { "$ref": "#/$defs/optionalString" },
+        "edition": { "$ref": "#/$defs/optionalString" },
+        "publisher": { "$ref": "#/$defs/optionalString" },
+        "address": { "$ref": "#/$defs/optionalString" },
+        "organization": { "$ref": "#/$defs/optionalString" },
+        "chapter": { "$ref": "#/$defs/optionalString" },
+        "month": { "$ref": "#/$defs/optionalString" },
+        "howpublished": { "$ref": "#/$defs/optionalString" },
+        "type": {
+          "description": "BibTeX's `type` field: a report's own label, or a section label for a chapter. Not the entry type, which is `entry_type`.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "category": {
+          "description": "The category of the bib_files entry the file was listed under, not anything in the .bib file.",
+          "type": "string"
+        },
+        "entry_type": {
+          "description": "The BibTeX entry type, lower-cased.",
+          "type": "string",
+          "minLength": 1
+        },
+        "abstract": { "$ref": "#/$defs/optionalString" },
+        "note": { "$ref": "#/$defs/optionalString" },
+        "awards": {
+          "description": "The awards this work received, in the order the entry's `award` field wrote them; `[]` when it names none. Awards held by a person are not here.",
+          "type": "array",
+          "items": { "$ref": "#/$defs/award" }
+        },
+        "identifiers": { "$ref": "#/$defs/identifierMap" },
+        "links": { "$ref": "#/$defs/linkMap" },
+        "project_ids": { "$ref": "#/$defs/idList" },
+        "bibtex": {
+          "description": "The entry re-serialized as BibTeX, for a reader to copy, and null when it could not be written back out. It is a re-serialization of the entry's data and explicitly not a source of properties.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "derived": { "$ref": "#/$defs/derived" }
+      }
+    },
+    "person": {
+      "type": "object",
+      "required": [
+        "id", "name", "role", "status", "photo", "email", "website",
+        "co_advisor", "start_year", "end_year", "degree", "thesis_title",
+        "current_position", "work_ids", "derived"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "name": { "type": "string", "minLength": 1 },
+        "role": { "$ref": "#/$defs/optionalString" },
+        "status": { "type": "string" },
+        "photo": { "$ref": "#/$defs/optionalString" },
+        "email": { "$ref": "#/$defs/optionalString" },
+        "website": { "$ref": "#/$defs/optionalString" },
+        "co_advisor": { "$ref": "#/$defs/optionalString" },
+        "start_year": { "type": ["integer", "null"] },
+        "end_year": { "type": ["integer", "null"] },
+        "degree": { "$ref": "#/$defs/optionalString" },
+        "thesis_title": { "$ref": "#/$defs/optionalString" },
+        "current_position": { "$ref": "#/$defs/optionalString" },
+        "work_ids": {
+          "description": "The works this person authored. Editors are not authorships and are not listed.",
+          "$ref": "#/$defs/idList"
+        },
+        "derived": { "$ref": "#/$defs/derived" }
+      }
+    },
+    "project": {
+      "type": "object",
+      "required": [
+        "id", "title", "description", "website", "image", "status",
+        "work_ids", "people_ids", "derived"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "title": { "type": "string" },
+        "description": { "$ref": "#/$defs/optionalString" },
+        "website": { "$ref": "#/$defs/optionalString" },
+        "image": {
+          "description": "A URL or a site path, the same kind of value as a person's `photo`. Plain text: deciding which URLs are safe to render is the renderer's job.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "status": { "type": "string" },
+        "work_ids": { "$ref": "#/$defs/idList" },
+        "people_ids": { "$ref": "#/$defs/idList" },
+        "derived": { "$ref": "#/$defs/derived" }
+      }
+    },
+    "collaborator": {
+      "description": "A grouping over unresolved authorships, not an identity. A consumer that distrusts the grouping can ignore it and work from `authorships` instead; that property is what makes the grouping safe to publish.",
+      "type": "object",
+      "required": [
+        "key", "grouped_by", "name_kind", "name", "given", "von", "family",
+        "suffix", "literal", "name_variants", "authorships", "work_ids",
+        "last_year", "derived"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "key": {
+          "description": "A lookup key, explicitly not an assertion about a human: a readable slug of the normalised name plus an always-present short digest, so adding an unrelated collaborator can never change an existing key.",
+          "type": "string",
+          "minLength": 1
+        },
+        "grouped_by": {
+          "description": "The policy that built the key. An open string; `normalized_name`, or `declared` for a grouping the collaborators file declares.",
+          "type": "string",
+          "minLength": 1
+        },
+        "name_kind": {
+          "description": "`personal` or `literal`. Not `person`/`organization`: brace protection in BibTeX means `do not parse this`, which covers organisations but also mononyms, so the document must not assert corporate-ness.",
+          "enum": ["personal", "literal"]
+        },
+        "name": {
+          "description": "The readable form of the first spelling this key grouped, in document order.",
+          "type": "string",
+          "minLength": 1
+        },
+        "given": { "$ref": "#/$defs/optionalString" },
+        "von": { "$ref": "#/$defs/optionalString" },
+        "family": { "$ref": "#/$defs/optionalString" },
+        "suffix": { "$ref": "#/$defs/optionalString" },
+        "literal": { "$ref": "#/$defs/optionalString" },
+        "name_variants": {
+          "description": "The distinct source spellings that normalised to this key, ascending.",
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 },
+          "uniqueItems": true
+        },
+        "authorships": {
+          "description": "The occurrences this key grouped, in document order.",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["work_id", "position"],
+            "additionalProperties": false,
+            "properties": {
+              "work_id": { "type": "string", "minLength": 1 },
+              "position": { "type": "integer", "minimum": 1 }
+            }
+          },
+          "minItems": 1
+        },
+        "work_ids": {
+          "description": "The distinct works this key grouped, in document order. One work listing two authorships under this key appears once; `authorships` lists both.",
+          "$ref": "#/$defs/idList"
+        },
+        "last_year": {
+          "description": "The greatest year of any work contributing an occurrence, or null when none of them has one.",
+          "type": ["integer", "null"]
+        },
+        "derived": { "$ref": "#/$defs/derived" }
+      }
+    }
+  }
+}

{sslabdata-3.1.0 → sslabdata-4.0.0}/sslabdata/__init__.py

@@ -12,7 +12,7 @@ MIT License - see LICENSE file for details.
 
 from .config import ConfigurationError, LabDataConfig, BibFile
 from .models import (
-    LabData, Work, Author, Contributor, Venue, Link, Person, Project,
+    LabData, Work, Award, Author, Contributor, Venue, Link, Person, Project,
     Collaborator,
 )
 from .assembler import assemble, AssemblyError, AssemblyResult
@@ -24,6 +24,7 @@ __all__ = [
     "ConfigurationError",
     "LabData",
     "Work",
+    "Award",
     "Author",
     "Contributor",
     "Venue",
@@ -37,4 +38,4 @@ __all__ = [
     "export_to_yaml",
     "export_to_json",
 ]
-__version__ = "3.1.0"
+__version__ = "4.0.0"

{sslabdata-3.1.0 → sslabdata-4.0.0}/sslabdata/diagnostics.py

@@ -89,6 +89,8 @@ CLASSES: Dict[str, str] = {
     "BIB-YEAR-MISSING": WARNING,
     "BIB-YEAR-INVALID": WARNING,
     "BIB-DOI-INVALID": WARNING,
+    "BIB-AWARD-EMPTY": WARNING,
+    "BIB-AWARD-YEAR-MALFORMED": WARNING,
     "BIB-OTHERS-NOT-LAST": WARNING,
     "BIB-STRING-UNDEFINED": WARNING,
     "BIB-STRING-REDEFINED": WARNING,

{sslabdata-3.1.0 → sslabdata-4.0.0}/sslabdata/models.py

@@ -18,9 +18,9 @@ from typing import Dict, List, Optional
 from .config import json_lab, reject_absolute_name
 
 
-# The document's schema version (schema/v5/output.schema.json). When it
+# The document's schema version (schema/v6/output.schema.json). When it
 # changes is SPEC.md §6.
-SCHEMA_VERSION = 5
+SCHEMA_VERSION = 6
 
 GENERATOR_NAME = "sslabdata"
 
@@ -56,6 +56,17 @@ class Link:
         }
 
 
+@dataclass
+class Award:
+    """One award a work received: its name, and the year it was given, which
+    need not be the work's (SPEC.md §5)."""
+    name: str
+    year: Optional[int] = None
+
+    def to_dict(self) -> dict:
+        return {'name': self.name, 'year': self.year}
+
+
 @dataclass
 class Contributor:
     """One person named on a work: the parts of the name, and who it resolved
@@ -152,6 +163,10 @@ class Work:
     bibtex: Optional[str] = None
     derived: Dict[str, object] = field(default_factory=dict)
 
+    # Declared last so it takes no other field's position in a positional
+    # call; to_dict() emits it beside `note`.
+    awards: List[Award] = field(default_factory=list)
+
     def to_dict(self) -> dict:
         """Convert to dictionary for serialization.
 
@@ -184,6 +199,7 @@ class Work:
             'entry_type': self.entry_type,
             'abstract': self.abstract,
             'note': self.note,
+            'awards': [award.to_dict() for award in self.awards],
             'identifiers': {scheme: list(values)
                             for scheme, values in self.identifiers.items()},
             'links': {kind: [link.to_dict() for link in links]

{sslabdata-3.1.0 → sslabdata-4.0.0}/sslabdata/parsers/bibtex.py

@@ -21,6 +21,7 @@ from typing import Callable, Dict, List, Optional, Tuple
 from urllib.parse import urlsplit
 
 import pybtex.errors
+from pybtex.bibtex.utils import split_tex_string
 from pybtex.database import BibliographyData, Entry, Person
 from pybtex.exceptions import PybtexError
 from pybtex.database.output.bibtex import Writer as BibTeXWriter
@@ -34,7 +35,7 @@ from ..config import (
     CONTROL_CHARACTER, control_message, nfc, without_control_characters,
 )
 from ..diagnostics import Diagnostic, diagnostic
-from ..models import Author, Contributor, Link, Venue, Work
+from ..models import Author, Award, Contributor, Link, Venue, Work
 
 
 # The fields converted from LaTeX to plain text (SPEC.md §2). The repository
@@ -1085,6 +1086,86 @@ def extract_note(entry: dict) -> Optional[str]:
     return note
 
 
+# The award list is split as BibTeX splits `author` (SPEC.md §5): on `and`, in
+# any case, with whitespace on both sides, outside braces. The whitespace
+# before it is part of the separator and the whitespace after it is not, so
+# `and and` is two separators with an empty award between them. The value is
+# padded with a space at each end before it is split, so an `and` that opens
+# or closes the list separates an empty award too.
+AWARD_SEPARATOR = r"[ \t\r\n][Aa][Nn][Dd](?=[ \t\r\n])"
+
+# The year an award was given, written before it: four ASCII digits, a colon
+# and whitespace. The whitespace is not needed when nothing follows, so
+# `2026:` alone is a year with no name rather than a malformed prefix.
+AWARD_YEAR = re.compile(r"([0-9]{4}):(?:\s+|$)")
+
+# What an author may have meant as a year and did not write as one: digits of
+# any kind and a colon, or four digits and a space with no colon between them.
+AWARD_YEAR_LIKE = re.compile(r"\d+\s*:|\d{4}\s")
+
+AWARD_EMPTY = "BIB-AWARD-EMPTY"
+AWARD_YEAR_MALFORMED = "BIB-AWARD-YEAR-MALFORMED"
+
+
+def split_awards(value: str) -> List[str]:
+    """One `award` field value split into its awards, each as written and
+    trimmed, with an empty string for each empty award.
+
+    pybtex's own brace-aware splitter does the work, so braces protect an
+    `and` exactly as they do in a name list.
+    """
+    return split_tex_string(f" {value} ", AWARD_SEPARATOR)
+
+
+def parse_awards(entry: dict, work_year: Optional[int], source: str, report,
+                 on_unknown) -> List[Award]:
+    """The work's awards, from its `award` field, in the order written
+    (SPEC.md §5).
+
+    Each award may start with the year it was given, `YYYY:`, read before
+    its name is converted from LaTeX; without one it takes ``work_year``. An
+    empty award is dropped and reported, and so is a year with no name after
+    it. A prefix that is not a year is reported and kept in the name.
+    """
+    raw = entry.get("award")
+    if raw is None:
+        return []
+    key = entry.get("ID")
+    if not raw.strip():
+        report(diagnostic(AWARD_EMPTY, source, key, "award",
+                          "the award field names no award; the work has none"))
+        return []
+    items = split_awards(raw)
+    awards: List[Award] = []
+    for position, item in enumerate(items, 1):
+        where = f"award {position} of {len(items)}"
+        year = work_year
+        text = item
+        prefix = AWARD_YEAR.match(item)
+        malformed = None if prefix else AWARD_YEAR_LIKE.match(item)
+        if prefix:
+            year = int(prefix.group(1))
+            text = item[prefix.end():]
+        elif malformed:
+            report(diagnostic(
+                AWARD_YEAR_MALFORMED, source, key, "award",
+                f"{where}, '{item}', starts with "
+                f"'{malformed.group().strip()}', which is not a year "
+                "prefix: that is four digits 0-9, a colon and a space. It is "
+                "kept as part of the name, and the award takes the work's "
+                "year"))
+        name = _convert(text, on_unknown).strip()
+        if not name:
+            written = f", '{item}', has a year and no name" if prefix else \
+                " is empty"
+            report(diagnostic(AWARD_EMPTY, source, key, "award",
+                              f"{where}{written}; it is dropped, and the "
+                              "other awards are kept"))
+            continue
+        awards.append(Award(name=name, year=year))
+    return awards
+
+
 def parse_project_ids(entry: dict) -> List[str]:
     """Parse the project field from a BibTeX entry."""
     project_field = entry.get("project", "").strip()
@@ -1165,7 +1246,7 @@ def entry_to_work(
     check_entry_type(fields, source, report)
     check_others(entry, bib_id, source, report)
 
-    return Work(
+    work = Work(
         bib_id=bib_id,
         title=fields.get("title", ""),
         authors=parse_author_list(entry, unknown_in("author")),
@@ -1182,11 +1263,17 @@ def entry_to_work(
                           source=source, report=report),
         project_ids=parse_project_ids(fields),
         bibtex=format_bibtex(bib_id, entry, source, report),
-        # Empty, as its default is; named so that the mapping below is
-        # type-checked against the flat fields alone.
+        # Empty, as their defaults are; named so that the mapping below is
+        # type-checked against the flat fields alone. The awards are read
+        # below, once the work's year is.
         derived={},
+        awards=[],
         **{name: fields.get(name) for name in FLAT_FIELDS},
     )
+    # An award without a year of its own takes the work's.
+    work.awards = parse_awards(fields, work.year, source, report,
+                               unknown_in("award"))
+    return work
 
 
 def _encoding_error(path: str, error: UnicodeDecodeError) -> Diagnostic:

{sslabdata-3.1.0 → sslabdata-4.0.0}/sslabdata/templates/init/bib/publications.bib

@@ -1,5 +1,7 @@
 % A fictional work to start from: replace it with your own entries.
-% `project` names a project id from projects.yaml.
+% `project` names a project id from projects.yaml. `award` lists the work's
+% awards, separated by `and`; start one with `YYYY: ` when it was given in
+% another year than the work's.
 
 @article{adams2024tidy,
   title   = {Learning to Tidy Up from Demonstrations},
@@ -7,5 +9,6 @@
   journal = {Journal of Example Robotics},
   year    = {2024},
   url     = {https://example.org/papers/adams2024tidy},
+  award   = {Best Paper Award},
   project = {homebot}
 }

{sslabdata-3.1.0 → sslabdata-4.0.0/sslabdata.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sslabdata
-Version: 3.1.0
+Version: 4.0.0
 Summary: Renderer-agnostic academic lab data assembler: BibTeX + YAML → structured data
 Author: Siddhartha Srinivasa
 License-Expression: MIT
@@ -37,6 +37,11 @@ Dynamic: license-file
 
 # sslabdata
 
+[![PyPI](https://img.shields.io/pypi/v/sslabdata.svg)](https://pypi.org/project/sslabdata/)
+[![Python](https://img.shields.io/pypi/pyversions/sslabdata.svg)](https://pypi.org/project/sslabdata/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/siddhss5/sslabdata/blob/main/LICENSE)
+[![Tests](https://github.com/siddhss5/sslabdata/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/siddhss5/sslabdata/actions/workflows/test.yml)
+
 sslabdata compiles BibTeX and a little YAML into one schema-specified document —
 works, people, projects and the links between them — that any website, CV or
 script can read.
@@ -56,10 +61,11 @@ sslabdata --config lab.yaml --output lab.yml
   order the lists are in, which fields are derived, when the version changes.
 - [`CHANGELOG.md`](https://github.com/siddhss5/sslabdata/blob/main/CHANGELOG.md) — what changed at each release, and what it
   replaced.
-- [`schema/v5/output.schema.json`](https://github.com/siddhss5/sslabdata/blob/main/schema/v5/output.schema.json) — the
+- [`schema/v6/output.schema.json`](https://github.com/siddhss5/sslabdata/blob/main/schema/v6/output.schema.json) — the
   document's JSON Schema. Published versions are immutable and live at their
-  own paths; [`schema/v3/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v3/output.schema.json) and
-  [`schema/v4/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v4/output.schema.json) are still there.
+  own paths; [`schema/v3/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v3/output.schema.json),
+  [`schema/v4/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v4/output.schema.json) and
+  [`schema/v5/`](https://github.com/siddhss5/sslabdata/blob/main/schema/v5/output.schema.json) are still there.
 - [`tests/COVERAGE.md`](https://github.com/siddhss5/sslabdata/blob/main/tests/COVERAGE.md) — every input case sslabdata
   supports, and every case it does not, with the fixture and test for each.
 
@@ -182,6 +188,7 @@ nothing else:
 | `doi`, `isbn`, `issn`, `eprint` + `archivePrefix` (or `eprinttype`) | `identifiers`, an open map from scheme to a list of identifiers, plus the links built from them. An `eprint`'s scheme is the repository `archivePrefix` or `eprinttype` named, lower-cased, so that field needs no property of its own — and an `eprint` in a repository other than arXiv gets no arXiv link |
 | `abstract` | `abstract` |
 | `note` | `note` |
+| `award` | `awards`, a list of `{name, year}` (see below). `note` is never read for awards |
 | `url` | A link of kind `video` when its host is YouTube or Vimeo (or a subdomain of either), otherwise of kind `url` |
 | `video` | A link of kind `video`, whatever its host, so `url` can hold the work's website |
 | `pdf` | The work's one link of kind `pdf`. An entry without it gets `pdf_base_url` plus its citation key, when `pdf_base_url` is set |
@@ -192,6 +199,26 @@ The entry is also re-serialized into a `bibtex` field, so fields sslabdata does
 not interpret are still carried. It is a re-serialization, not a copy
 ([`SPEC.md` §5](https://github.com/siddhss5/sslabdata/blob/main/SPEC.md#5-input-versus-derived)).
 
+### Awards
+
+A paper's awards go in its `award` field. Several are separated by `and`, as
+the names in `author` are, and braces keep an `and` inside one name. An award
+may start with the year it was given, as `YYYY:` and a space, when that is not
+the paper's year:
+
+```bibtex
+award = {2026: Test of Time Award and {Best Systems and Software Paper Award}}
+```
+
+Each award becomes `{name, year}` in the work's `awards`, in the order
+written, with its name converted from LaTeX as `title` is. An award without a
+year takes the work's `year`, or `null` when the work has none. `awards` is
+`[]` for a work with no `award` field. An empty award, or a prefix that looks
+like a year and is not four digits, a colon and a space, is reported
+(`BIB-AWARD-EMPTY`, `BIB-AWARD-YEAR-MALFORMED`); a malformed prefix stays in
+the name. Awards a person holds, such as fellowships, are not part of the
+document.
+
 ### The `project` tag
 
 sslabdata adds one custom BibTeX field, `project`, to link a paper to a research
@@ -205,6 +232,7 @@ project:
   year      = {2024},
   eprint    = {2406.99812},
   archivePrefix = {arXiv},
+  award     = {Best Paper Award},
   project   = {homebot}
 }
 ```
@@ -349,7 +377,7 @@ pip install jsonschema
 python -c "
 import json, yaml, jsonschema
 from importlib.resources import files
-schema = json.loads(files('sslabdata.schema').joinpath('v5/output.schema.json').read_text())
+schema = json.loads(files('sslabdata.schema').joinpath('v6/output.schema.json').read_text())
 jsonschema.Draft202012Validator(schema).validate(yaml.safe_load(open('lab.yml')))
 print('valid')
 "

{sslabdata-3.1.0 → sslabdata-4.0.0}/sslabdata.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ schema/input/v1/projects.schema.json
 schema/v3/output.schema.json
 schema/v4/output.schema.json
 schema/v5/output.schema.json
+schema/v6/output.schema.json
 sslabdata/__init__.py
 sslabdata/assembler.py
 sslabdata/cli.py