inclusio 0.0.2__tar.gz

inclusio-0.0.2/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: inclusio
+Version: 0.0.2
+Summary: Accessibility-first publishing engine — PDF/UA-2 + WTPDF + PDF/A-4f, C2PA + PAdES + SLSA provenance, multi-format emission, MCP server.
+Author-email: Sebastien Rousseau <contact@sebastienrousseau.com>
+License: MIT
+Project-URL: Homepage, https://github.com/sebastienrousseau/inclusio
+Project-URL: Documentation, https://github.com/sebastienrousseau/inclusio/tree/main/docs
+Project-URL: Issues, https://github.com/sebastienrousseau/inclusio/issues
+Project-URL: Changelog, https://github.com/sebastienrousseau/inclusio/blob/main/CHANGELOG.md
+Keywords: latex,publishing,euxis,pdfa,pdfua,wtpdf,accessibility,eaa,wcag,tagged-pdf,uspto,arxiv
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: pikepdf>=8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: pytest-benchmark>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.6.0; extra == "dev"
+Requires-Dist: interrogate>=1.7; extra == "dev"
+Requires-Dist: sphinx>=7.0; extra == "dev"
+Requires-Dist: myst-parser>=2.0; extra == "dev"
+Requires-Dist: furo>=2024.0.0; extra == "dev"
+Provides-Extra: mcp
+Requires-Dist: mcp[cli]>=1.27.0; extra == "mcp"
+Provides-Extra: provenance
+Requires-Dist: pyhanko>=0.22; extra == "provenance"
+
+<p align="center">
+  <img src="https://kura.pro/euxis/images/logos/euxis.svg" alt="Inclusio logo" width="128" />
+</p>
+
+<h1 align="center">Inclusio</h1>
+
+<p align="center">
+  <strong>Publishing that includes everyone.</strong>
+</p>
+
+<p align="center">
+  Accessibility-first publishing engine for LaTeX, packaged as a
+  Python CLI. PDF/UA-2 + WTPDF + PDF/A-4f triple-conformance,
+  C2PA + PAdES + SLSA provenance, multi-format emission (HTML5 /
+  JATS / EPUB3), LLM-augmented judges, and an MCP server for agent
+  integration. Built for macOS, Linux, and WSL.
+</p>
+
+<p align="center">
+  <a href="https://github.com/sebastienrousseau/inclusio/actions/workflows/engine-validation.yml"><img src="https://img.shields.io/github/actions/workflow/status/sebastienrousseau/inclusio/engine-validation.yml?style=for-the-badge&logo=github" alt="Engine Validation" /></a>
+  <a href="https://github.com/sebastienrousseau/inclusio/actions/workflows/verapdf.yml"><img src="https://img.shields.io/github/actions/workflow/status/sebastienrousseau/inclusio/verapdf.yml?style=for-the-badge&logo=github&label=veraPDF" alt="veraPDF Audit" /></a>
+  <a href="https://github.com/sebastienrousseau/inclusio"><img src="https://img.shields.io/badge/Python-%3E%3D3.11-3776AB?style=for-the-badge&logo=python&logoColor=white" alt="Python >= 3.11" /></a>
+  <a href="https://github.com/sebastienrousseau/inclusio"><img src="https://img.shields.io/badge/PDF%2FUA--2%20%7C%20WTPDF%20%7C%20PDF%2FA--4f-blue?style=for-the-badge" alt="PDF/UA-2 | WTPDF | PDF/A-4f" /></a>
+  <a href="https://github.com/sebastienrousseau/inclusio/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-black?style=for-the-badge" alt="License" /></a>
+</p>
+
+---
+
+## Install
+
+Run the local bootstrap:
+
+```bash
+./bin/setup
+```
+
+Then validate the engine:
+
+```bash
+make test
+make coverage
+```
+
+**Requires** `python3`, `git`, and a TeX toolchain. Use WSL for full Windows support. Install `tagpdf.sty` if you need accessibility tagging.
+
+---
+
+## Publish
+
+Publish against the private content repository with the shell-agnostic form:
+
+```bash
+make publish CONTENT_DIR=/absolute/path/to/inclusio-private
+```
+
+Use the shell-specific form only when you need it:
+
+```bash
+# Bash / Zsh / POSIX sh
+INCLUSIO_CONTENT_DIR=/absolute/path/to/inclusio-private make publish
+
+# fish
+env INCLUSIO_CONTENT_DIR=/absolute/path/to/inclusio-private make publish
+
+# PowerShell
+$env:INCLUSIO_CONTENT_DIR = "/absolute/path/to/inclusio-private"
+make publish
+```
+
+`EUXIS_PUBLISHER_CONTENT_DIR` is **not** supported.
+
+Drop supported briefs into `data/jobs/` in the private content repo, then run
+`publish`. The build now promotes `.txt`, `.md`, `.markdown`, `.rtf`, `.doc`,
+`.docx`, `.odt`, and `.html` briefs into `data/tailored/` automatically before
+compiling PDFs.
+
+---
+
+## Overview
+
+Use this repository as the public engine layer of the Euxis publishing stack.
+Keep private content in `inclusio-private`.
+
+You get:
+
+- **LaTeX classes and styles** through `core/cls/` and `core/sty/`
+- **Packaged Python entrypoints** through `inclusio/cli/`
+- **Operator utilities** through `inclusio/tools/`
+- **Compatibility wrappers** through `scripts/`
+- **Public fixture content** through `data/`, `src/`, and `templates/`
+- **100% package coverage** over `inclusio`
+
+---
+
+## Architecture
+
+First, render or tailor content. Then compile camera-ready output from the same engine.
+
+```mermaid
+graph TD
+    A[Private or Public Content] --> B{inclusio.cli.build}
+    B --> C[Render: Jinja2 to LaTeX or Markdown]
+    B --> D[Build: latexmk or TeX compiler]
+    B --> E[Tailor: Brief to structured YAML]
+    C --> F[build/.cache/rendered]
+    D --> G[PDF artifacts]
+    E --> H[data/tailored]
+    G --> I[Stamping and metadata tooling]
+```
+
+---
+
+## Features
+
+| | |
+| :--- | :--- |
+| **Engine** | Packaged Python CLI with `build`, `render`, `blog`, `tailor`, `lint`, and cleanup commands |
+| **Typography** | Shared LaTeX classes and style packages for CVs, papers, patents, FAQs, guides, and bios |
+| **Build Modes** | Draft, submission, and camera-ready flows managed from one orchestration layer |
+| **Publishing** | PDF/A-oriented metadata flow with provenance stamping support |
+| **Fixtures** | Public sample content for engine validation without exposing private briefs or templates |
+| **Coverage** | 100% package coverage across `inclusio` |
+| **Platforms** | macOS, Linux, and WSL |
+| **Docs** | Sphinx docs plus folder-level READMEs for every major public surface |
+
+---
+
+## Commands
+
+| Command | Execute this to... |
+| :--- | :--- |
+| `make list` | inspect registered documents |
+| `make draft` | compile all public documents in draft mode |
+| `make final` | compile camera-ready output from the current content root |
+| `make publish CONTENT_DIR=/absolute/path/to/inclusio-private` | auto-tailor briefs from `data/jobs/` and compile the full private set |
+| `make render` | render Jinja2 templates to LaTeX |
+| `make render-md` | render Markdown output |
+| `make blog` | render blog posts |
+| `make tailor BRIEF=data/jobs/job.txt` | generate one tailored document explicitly and build it |
+| `make sitemap` | generate `build/site-map.json` |
+| `make test` | run the public engine test target |
+| `make coverage` | enforce the package coverage gate |
+| `make docs` | build the Sphinx site |
+
+Use the packaged CLIs directly when you need lower-level control:
+
+```bash
+python3 -m inclusio.cli.build list
+python3 -m inclusio.cli.render --doc cv
+python3 -m inclusio.cli.sitemap --pretty
+python3 -m inclusio.cli.tailor data/jobs/test.txt --no-ai
+```
+
+For bulk private publishing, prefer `make publish`. It scans `data/jobs/`,
+refreshes stale tailored YAML, and compiles the resulting PDFs in one pass.
+
+---
+
+## Public vs Private Boundary
+
+Keep these surfaces public:
+
+- `core/`
+- `inclusio/`
+- `scripts/`
+- `tests/`
+- non-sensitive fixtures in `data/`, `src/`, and `templates/`
+- CI, docs, and build metadata
+
+Keep these surfaces private:
+
+- real briefs and client content
+- proprietary templates and assets
+- content-bearing metadata sets
+- content-specific QA and linguistic validation
+
+For the full boundary contract, read [docs/public-private-boundary.md](docs/public-private-boundary.md).
+
+---
+
+## Documentation
+
+Start here:
+
+- [docs/README.md](docs/README.md)
+- [docs/architecture.md](docs/architecture.md)
+- [docs/classes-and-styles.md](docs/classes-and-styles.md)
+- [docs/package-reference.md](docs/package-reference.md)
+- [docs/macro-reference.md](docs/macro-reference.md)
+- [docs/usage.md](docs/usage.md)
+- [docs/testing-and-ci.md](docs/testing-and-ci.md)
+
+Folder guides:
+
+- [bin/README.md](bin/README.md)
+- [core/README.md](core/README.md)
+- [data/README.md](data/README.md)
+- [inclusio/README.md](inclusio/README.md)
+- [inclusio/cli/README.md](inclusio/cli/README.md)
+- [inclusio/tools/README.md](inclusio/tools/README.md)
+- [scripts/README.md](scripts/README.md)
+- [src/README.md](src/README.md)
+- [templates/README.md](templates/README.md)
+- [tests/README.md](tests/README.md)
+
+---
+
+## License
+
+Licensed under the **MIT License**. See [LICENSE](LICENSE) for details.

inclusio-0.0.2/README.md

@@ -0,0 +1,210 @@
+<p align="center">
+  <img src="https://kura.pro/euxis/images/logos/euxis.svg" alt="Inclusio logo" width="128" />
+</p>
+
+<h1 align="center">Inclusio</h1>
+
+<p align="center">
+  <strong>Publishing that includes everyone.</strong>
+</p>
+
+<p align="center">
+  Accessibility-first publishing engine for LaTeX, packaged as a
+  Python CLI. PDF/UA-2 + WTPDF + PDF/A-4f triple-conformance,
+  C2PA + PAdES + SLSA provenance, multi-format emission (HTML5 /
+  JATS / EPUB3), LLM-augmented judges, and an MCP server for agent
+  integration. Built for macOS, Linux, and WSL.
+</p>
+
+<p align="center">
+  <a href="https://github.com/sebastienrousseau/inclusio/actions/workflows/engine-validation.yml"><img src="https://img.shields.io/github/actions/workflow/status/sebastienrousseau/inclusio/engine-validation.yml?style=for-the-badge&logo=github" alt="Engine Validation" /></a>
+  <a href="https://github.com/sebastienrousseau/inclusio/actions/workflows/verapdf.yml"><img src="https://img.shields.io/github/actions/workflow/status/sebastienrousseau/inclusio/verapdf.yml?style=for-the-badge&logo=github&label=veraPDF" alt="veraPDF Audit" /></a>
+  <a href="https://github.com/sebastienrousseau/inclusio"><img src="https://img.shields.io/badge/Python-%3E%3D3.11-3776AB?style=for-the-badge&logo=python&logoColor=white" alt="Python >= 3.11" /></a>
+  <a href="https://github.com/sebastienrousseau/inclusio"><img src="https://img.shields.io/badge/PDF%2FUA--2%20%7C%20WTPDF%20%7C%20PDF%2FA--4f-blue?style=for-the-badge" alt="PDF/UA-2 | WTPDF | PDF/A-4f" /></a>
+  <a href="https://github.com/sebastienrousseau/inclusio/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-black?style=for-the-badge" alt="License" /></a>
+</p>
+
+---
+
+## Install
+
+Run the local bootstrap:
+
+```bash
+./bin/setup
+```
+
+Then validate the engine:
+
+```bash
+make test
+make coverage
+```
+
+**Requires** `python3`, `git`, and a TeX toolchain. Use WSL for full Windows support. Install `tagpdf.sty` if you need accessibility tagging.
+
+---
+
+## Publish
+
+Publish against the private content repository with the shell-agnostic form:
+
+```bash
+make publish CONTENT_DIR=/absolute/path/to/inclusio-private
+```
+
+Use the shell-specific form only when you need it:
+
+```bash
+# Bash / Zsh / POSIX sh
+INCLUSIO_CONTENT_DIR=/absolute/path/to/inclusio-private make publish
+
+# fish
+env INCLUSIO_CONTENT_DIR=/absolute/path/to/inclusio-private make publish
+
+# PowerShell
+$env:INCLUSIO_CONTENT_DIR = "/absolute/path/to/inclusio-private"
+make publish
+```
+
+`EUXIS_PUBLISHER_CONTENT_DIR` is **not** supported.
+
+Drop supported briefs into `data/jobs/` in the private content repo, then run
+`publish`. The build now promotes `.txt`, `.md`, `.markdown`, `.rtf`, `.doc`,
+`.docx`, `.odt`, and `.html` briefs into `data/tailored/` automatically before
+compiling PDFs.
+
+---
+
+## Overview
+
+Use this repository as the public engine layer of the Euxis publishing stack.
+Keep private content in `inclusio-private`.
+
+You get:
+
+- **LaTeX classes and styles** through `core/cls/` and `core/sty/`
+- **Packaged Python entrypoints** through `inclusio/cli/`
+- **Operator utilities** through `inclusio/tools/`
+- **Compatibility wrappers** through `scripts/`
+- **Public fixture content** through `data/`, `src/`, and `templates/`
+- **100% package coverage** over `inclusio`
+
+---
+
+## Architecture
+
+First, render or tailor content. Then compile camera-ready output from the same engine.
+
+```mermaid
+graph TD
+    A[Private or Public Content] --> B{inclusio.cli.build}
+    B --> C[Render: Jinja2 to LaTeX or Markdown]
+    B --> D[Build: latexmk or TeX compiler]
+    B --> E[Tailor: Brief to structured YAML]
+    C --> F[build/.cache/rendered]
+    D --> G[PDF artifacts]
+    E --> H[data/tailored]
+    G --> I[Stamping and metadata tooling]
+```
+
+---
+
+## Features
+
+| | |
+| :--- | :--- |
+| **Engine** | Packaged Python CLI with `build`, `render`, `blog`, `tailor`, `lint`, and cleanup commands |
+| **Typography** | Shared LaTeX classes and style packages for CVs, papers, patents, FAQs, guides, and bios |
+| **Build Modes** | Draft, submission, and camera-ready flows managed from one orchestration layer |
+| **Publishing** | PDF/A-oriented metadata flow with provenance stamping support |
+| **Fixtures** | Public sample content for engine validation without exposing private briefs or templates |
+| **Coverage** | 100% package coverage across `inclusio` |
+| **Platforms** | macOS, Linux, and WSL |
+| **Docs** | Sphinx docs plus folder-level READMEs for every major public surface |
+
+---
+
+## Commands
+
+| Command | Execute this to... |
+| :--- | :--- |
+| `make list` | inspect registered documents |
+| `make draft` | compile all public documents in draft mode |
+| `make final` | compile camera-ready output from the current content root |
+| `make publish CONTENT_DIR=/absolute/path/to/inclusio-private` | auto-tailor briefs from `data/jobs/` and compile the full private set |
+| `make render` | render Jinja2 templates to LaTeX |
+| `make render-md` | render Markdown output |
+| `make blog` | render blog posts |
+| `make tailor BRIEF=data/jobs/job.txt` | generate one tailored document explicitly and build it |
+| `make sitemap` | generate `build/site-map.json` |
+| `make test` | run the public engine test target |
+| `make coverage` | enforce the package coverage gate |
+| `make docs` | build the Sphinx site |
+
+Use the packaged CLIs directly when you need lower-level control:
+
+```bash
+python3 -m inclusio.cli.build list
+python3 -m inclusio.cli.render --doc cv
+python3 -m inclusio.cli.sitemap --pretty
+python3 -m inclusio.cli.tailor data/jobs/test.txt --no-ai
+```
+
+For bulk private publishing, prefer `make publish`. It scans `data/jobs/`,
+refreshes stale tailored YAML, and compiles the resulting PDFs in one pass.
+
+---
+
+## Public vs Private Boundary
+
+Keep these surfaces public:
+
+- `core/`
+- `inclusio/`
+- `scripts/`
+- `tests/`
+- non-sensitive fixtures in `data/`, `src/`, and `templates/`
+- CI, docs, and build metadata
+
+Keep these surfaces private:
+
+- real briefs and client content
+- proprietary templates and assets
+- content-bearing metadata sets
+- content-specific QA and linguistic validation
+
+For the full boundary contract, read [docs/public-private-boundary.md](docs/public-private-boundary.md).
+
+---
+
+## Documentation
+
+Start here:
+
+- [docs/README.md](docs/README.md)
+- [docs/architecture.md](docs/architecture.md)
+- [docs/classes-and-styles.md](docs/classes-and-styles.md)
+- [docs/package-reference.md](docs/package-reference.md)
+- [docs/macro-reference.md](docs/macro-reference.md)
+- [docs/usage.md](docs/usage.md)
+- [docs/testing-and-ci.md](docs/testing-and-ci.md)
+
+Folder guides:
+
+- [bin/README.md](bin/README.md)
+- [core/README.md](core/README.md)
+- [data/README.md](data/README.md)
+- [inclusio/README.md](inclusio/README.md)
+- [inclusio/cli/README.md](inclusio/cli/README.md)
+- [inclusio/tools/README.md](inclusio/tools/README.md)
+- [scripts/README.md](scripts/README.md)
+- [src/README.md](src/README.md)
+- [templates/README.md](templates/README.md)
+- [tests/README.md](tests/README.md)
+
+---
+
+## License
+
+Licensed under the **MIT License**. See [LICENSE](LICENSE) for details.

inclusio-0.0.2/inclusio/__init__.py

@@ -0,0 +1 @@
+"""Inclusio package."""

inclusio-0.0.2/inclusio/cli/__init__.py

@@ -0,0 +1 @@
+"""CLI entrypoints for Inclusio."""