primarysource 0.1.0__tar.gz

primarysource-0.1.0/.gitattributes

@@ -0,0 +1,3 @@
+# RFC fixtures are byte-exact copies (sha256s, line numbers, form feeds):
+# never convert their line endings.
+tests/rfc/fixtures/** -text

primarysource-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,68 @@
+name: release
+
+# Tag vX.Y.Z (matching primarysource/__init__.py __version__) -> build, test the built wheel, publish to PyPI.
+# "Run workflow" by hand -> TestPyPI. Publishing uses PyPI trusted publishing (OIDC, no API tokens).
+# One-time setup on pypi.org / test.pypi.org: add a (pending) trusted publisher for owner b1tninja-labs,
+# repository primarysource, workflow "release.yml", environment "pypi" / "testpypi".
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - name: Tag matches __version__
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          v=$(python -c "import re;print(re.search(r'__version__ = \"(.+?)\"', open('primarysource/__init__.py').read()).group(1))")
+          test "v$v" = "${GITHUB_REF_NAME}" || { echo "tag ${GITHUB_REF_NAME} != v$v"; exit 1; }
+      - name: Full suite from the checkout (several tests read pyproject.toml, ROADMAP.md and .gitignore)
+        run: uv sync --extra dev --extra rfc --extra mcp --extra itu --extra ieee --extra ecma --extra bbf && uv run pytest -q
+      - run: uv build
+      - name: Smoke-test the built wheel, not the checkout
+        run: |
+          uv venv /tmp/wheeltest
+          uv pip install --python /tmp/wheeltest "$(ls dist/*.whl)[rfc,mcp,itu]"
+          cd /tmp && /tmp/wheeltest/bin/python -I -c "import primarysource, primarysource.rfc, primarysource.nist.collection; print(primarysource.__version__)"
+          /tmp/wheeltest/bin/primarysource collections
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  testpypi:
+    if: github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  pypi:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

primarysource-0.1.0/.gitignore

@@ -0,0 +1,69 @@
+# No document text lives in this repository: tests use invented text only.
+.venv/
+__pycache__/
+*.pyc
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+.coverage
+.coverage.*
+htmlcov/
+
+# Anything that could carry a corpus, by file type. A stray download is then never staged.
+*.pdf
+*.epub
+*.doc
+*.docx
+*.rtf
+*.zip
+*.zim
+# ZIM files in every spelling (the `zim` collection): a ZIM is one binary file that git history cannot take back.
+# `/zim/` is anchored: the collection's own code is primarysource/zim/ and tests/zim/.
+*.zim.*
+*.zimaa
+*.meta4
+*.idx.tmp/
+/zim/
+zimlore-home/
+.zimlore/
+*.sqlite3
+*.sqlite3-journal
+*.db
+*.db-wal
+*.db-shm
+*.sqlite
+*.sqlite-wal
+*.sqlite-shm
+*.csv.gz
+.cvelib/
+
+# Captures and secrets
+*.har
+.env
+.env.*
+*.pem
+*.key
+
+# Scratch: the workspace pre-commit hook refuses these
+probe_*.py
+*.log
+*.out
+*.tmp
+scratch/
+tmp/
+
+# Agent worktrees and local tool state
+.claude/worktrees/
+.claude/settings.local.json
+.vscode/
+.idea/
+
+.DS_Store
+Thumbs.db
+desktop.ini
+
+# A collection fetch target, should one ever be pointed inside the tree (itu licence test checks this)
+/corpus/

primarysource-0.1.0/AGENTS.md

@@ -0,0 +1,41 @@
+# Instructions for coding agents
+
+`primarysource` is the shared core of the citable document libraries in this workspace (`rfclibrary`, `itulibrary`,
+`zimlore`, `nistlibrary`, `usblibrary`): the sectioned-document model, the ref grammar, token-budgeted paging and,
+as they are built, readers, a full-text index, a CLI and an MCP server. `PLAN.md` says why and in what order;
+`ROADMAP.md` says what is pinned by a test.
+
+## Finding work
+
+If the person gave you a task, do that task. This project is not registered in `PORTFOLIO.md` yet, so the board
+has no rows for it: with no task, ask the person.
+
+## Commands
+
+```
+python -m pip install -e ".[dev]"
+python -m pytest -q
+python -m ruff check .
+python -m ruff format --check .
+python -m mypy primarysource tests
+```
+
+Python 3.12+: `from __future__ import annotations`, `collections.abc`, `X | None`, `datetime.UTC`. `ruff format`
+decides line breaks. Never run a formatter from above this directory.
+
+## Rules
+
+- **No document text in the tree.** Not a PDF, not an extract, not one clause in a fixture. ITU and USB-IF text
+  cannot be redistributed; tests use invented text, and must pass with no corpus anywhere. One exception:
+  `tests/rfc/fixtures/library/`, moved in with rfclib, holds unmodified copies of six RFCs. RFCs may be
+  redistributed under the IETF Trust Legal Provisions, and the fixture's README says so. Add no other real text.
+- **Move code here behind the tests that already pin it.** A function lifted from a library arrives with the
+  library's tests for it, and the library then imports it; a second copy that drifts is the problem this
+  repository exists to end.
+- **Streams, not extraction.** A reader takes bytes or a stream and never unpacks an archive to disk.
+- **An error names its remedy; an empty result means nothing matched.** Use `LibError(message, hint)`.
+- **A result is text with the fixed footer** (`primarysource/render.py`). Do not add a footer key without adding it
+  to `FOOTER_ORDER` and to `PLAN.md` §5.
+- **A new dependency arrives as an extra with the reader that needs it**, and its licence is read first.
+- **`[ok]` in `ROADMAP.md` needs a named test that exists.**
+- Do not edit the sibling libraries from here; adoption is a change in that library, under its own `AGENTS.md`.

primarysource-0.1.0/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

primarysource-0.1.0/NOTICE

@@ -0,0 +1,51 @@
+primarysource
+Copyright 2026 Justin Capella. Licensed under the Apache License, Version 2.0 (LICENSE).
+
+The collections moved in from the author's other libraries (rfclib, itulib, zimlore,
+nistlib, usblib, cvelib and any later *lib) are the same author's original work and
+are relicensed here under the Apache License 2.0, whatever licence they carried before.
+
+Document text is not part of this software's licence
+----------------------------------------------------
+primarysource ships no document text, with one exception: the test fixtures in
+tests/rfc/fixtures/library are unmodified copies of a few RFCs and trimmed
+copies of RFC Editor metadata, published by the IETF Trust under the IETF Trust
+Legal Provisions (https://trustee.ietf.org/license-info), not under this
+software's licence. RFCs may be copied and distributed in full but not modified
+outside the IETF Standards Process.
+
+Every other collection's documents are fetched by the user, under their
+publishers' own terms, and are stored outside this package.
+
+ZIM files (the `zim` collection)
+--------------------------------
+This repository contains no ZIM file and no text from any ZIM file. A ZIM is an archive of someone else's
+content, and each one carries that content's own licence: DevDocs ZIMs archive upstream project documentation
+under whatever licence each project chose, Stack Exchange ZIMs are user-contributed content under Creative
+Commons terms with attribution requirements, Wikipedia is another case again. Those licences differ from each
+other and from this software's. The collection therefore never ships, vendors or embeds ZIM content: files live
+in the collection's home (`$PRIMARYSOURCE_HOME/zim`, or `ZIMLORE_HOME` as before; subdirectory `zim/`) on each
+user's machine, fetched by the user with `primarysource zim get` or copied there, and `.gitignore` names every
+way a ZIM can be spelled so that one cannot be staged by accident. `tests/zim/test_license.py` is a tripwire
+against the obvious copy, not a proof against a determined one; its test ZIMs are built from invented text at
+test time, in a temporary directory.
+
+What the collection says about a document is a citation (library, ZIM edition date, entry path) plus the
+licence metadata the ZIM itself carries in its `License` field. Many ZIMs carry none, and the collection reports
+that as "not stated in the ZIM" rather than guessing: the licence of the text you reuse is the upstream
+project's, and you should read it there.
+
+The optional `zim` extra installs libzim (python-libzim), a compiled binding that is licensed GPL-3.0-or-later
+by its own authors. This package's wheel contains none of it and carries only this package's own code under the
+Apache License 2.0; libzim is a separately installed dependency under its own licence.
+
+cve (moved in from cvelib, MIT before the move) ships no vulnerability data either: records are fetched by the user
+with `primarysource cve sync` into the cve home, and its test fixtures are invented text. The sources keep their own
+terms, summarised in docs/cve-sources.md:
+
+- CVE List (cvelistV5) and the Linux kernel CNA repository: CVE Program Terms of Use, which ask that copies keep
+  MITRE's copyright designation and that licence.
+- CISA Known Exploited Vulnerabilities and Vulnrichment: CC0 1.0.
+- FIRST EPSS: published free of charge; cite it as FIRST EPSS, https://www.first.org/epss.
+- NVD (not ingested yet): if added, display "This product uses data from the NVD API but is not endorsed or
+  certified by the NVD."

primarysource-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.5
+Name: primarysource
+Version: 0.1.0
+Summary: Citable primary-source libraries for agents: RFCs, NIST, USB-IF, ITU-T, Kiwix and CVE collections behind one core (ref grammar, token-budgeted paging, full-text index, CLI, MCP server).
+Author: Justin Capella
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: citation,documents,full-text-search,mcp,model-context-protocol,standards
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Text Processing :: Indexing
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Provides-Extra: bbf
+Requires-Dist: pypdf>=5; extra == 'bbf'
+Provides-Extra: c2sp
+Provides-Extra: cavp
+Provides-Extra: cve
+Provides-Extra: debpolicy
+Provides-Extra: dev
+Requires-Dist: mypy>=1.20; extra == 'dev'
+Requires-Dist: packaging>=24; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.15; extra == 'dev'
+Provides-Extra: draft
+Provides-Extra: ecma
+Requires-Dist: pypdf>=5; extra == 'ecma'
+Provides-Extra: gitdocs
+Provides-Extra: iana
+Provides-Extra: ieee
+Requires-Dist: pypdf>=5; extra == 'ieee'
+Provides-Extra: iso
+Requires-Dist: pypdf>=5; extra == 'iso'
+Provides-Extra: itu
+Requires-Dist: pypdf>=5; extra == 'itu'
+Provides-Extra: kconfig
+Provides-Extra: mcp
+Requires-Dist: mcp>=2; extra == 'mcp'
+Provides-Extra: nist
+Provides-Extra: pep
+Provides-Extra: pms
+Provides-Extra: rfc
+Requires-Dist: httpx>=0.27; extra == 'rfc'
+Requires-Dist: rich>=13; extra == 'rfc'
+Requires-Dist: typer>=0.12; extra == 'rfc'
+Provides-Extra: rfc-semantic
+Requires-Dist: httpx>=0.27; extra == 'rfc-semantic'
+Requires-Dist: model2vec>=0.3; extra == 'rfc-semantic'
+Requires-Dist: rich>=13; extra == 'rfc-semantic'
+Requires-Dist: sqlite-vec; extra == 'rfc-semantic'
+Requires-Dist: typer>=0.12; extra == 'rfc-semantic'
+Provides-Extra: rfc-zim
+Requires-Dist: httpx>=0.27; extra == 'rfc-zim'
+Requires-Dist: libzim>=3.7; extra == 'rfc-zim'
+Requires-Dist: rich>=13; extra == 'rfc-zim'
+Requires-Dist: typer>=0.12; extra == 'rfc-zim'
+Provides-Extra: rpmdocs
+Provides-Extra: usb
+Provides-Extra: usbids
+Provides-Extra: zim
+Requires-Dist: libzim>=4.1; (sys_platform != 'win32' or platform_machine != 'ARM64') and extra == 'zim'
+Description-Content-Type: text/markdown
+
+# primarysource
+
+A primary source is the text itself: answer from it, and say exactly where it is.
+
+One package, many collections. The core is a sectioned-document model, a ref grammar, token-budgeted paging, a fixed result shape, readers, a full-text index, a CLI and an MCP server. Each collection is a subpackage behind an extra: `rfc` (the RFC series, moved in from rfclib), `nist`, `usb`, `itu`, `zim`, `cve`, and more. `PLAN.md` has the design and `ROADMAP.md` the open work.
+
+```
+pip install "primarysource[rfc,mcp]"
+primarysource collections
+primarysource mcp --collection rfc
+```
+
+Pre-alpha. It ships no document text: you fetch the sources yourself.
+
+## What works today
+
+```python
+from primarysource.budget import page
+from primarysource.model import Document, Section, Unit, span_hash
+from primarysource.refs import RefGrammar
+from primarysource.render import render
+
+grammar = RefGrammar(r"(?:RFC|BCP|STD)\d+")
+ref = grammar.parse("RFC9000§9.6¶2")          # Ref(doc='RFC9000', section='9.6', para=2)
+
+document = Document("demo", "Demo", Unit.SENTENCE, (Section("1", "Scope", ("First.", "Second.")),))
+section = document.section("1")
+result = page(section.units, start=1, max_tokens=2000)
+print(render(" ".join(result.units), {"cite": "Demo §1", "unit": document.unit, "span": span_hash("First.")}))
+```
+
+| Module | What it does |
+|---|---|
+| `primarysource.model` | `Document`, `Section`, the declared `Unit` that `¶n` counts, `span_hash` |
+| `primarysource.refs` | `RefGrammar`: `<doc>§<section>[#anchor][¶n]` and `<doc>:<first>-<last>`, for a library's own document-id pattern |
+| `primarysource.budget` | `tokens`, `page`: whole units up to a token budget, always making progress, with `next_start` |
+| `primarysource.render` | body plus `cite:`, `unit:`, `span:`, `next:`, `relaxed:`, `warning:` footer lines in a fixed order |
+| `primarysource.errors` | `LibError(message, hint)`: an error that names its remedy |
+| `primarysource.home` | `resolve_home(app)`: `$<APP>_HOME` or the per-user data directory; `atomic_write` |
+
+## What it does not do yet
+
+It reads no file format, builds no index, has no command and serves nothing. No library depends on it.
+
+## Tests
+
+`python -m pytest -q` from this directory. All tests use invented text.