octavo-kit 0.1.0__tar.gz

octavo_kit-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.pyc
+csl/*.csl
+.DS_Store
+dist/
+*.egg-info/

octavo_kit-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+Issues and pull requests are welcome, in English or Japanese.
+
+## Setup
+
+No install step beyond Python itself — `octavo` is intentionally
+stdlib-only (see [README.md](README.md)). For the full toolchain
+(pandoc/Typst) needed to actually build output, run `bash setup.sh`
+(add `--with-tex` for LaTeX/Beamer).
+
+## Running tests
+
+```bash
+python3 tests/test_octavo.py
+```
+
+Tests run with citations off and skip anything that needs a pandoc/TeX/Typst
+version newer than what's installed — a skip is expected in a minimal
+environment, not a failure. CI (`.github/workflows/tests.yml`) runs the same
+suite across Python 3.9–3.14 on every push and pull request.
+
+## Before opening a PR
+
+- Keep new dependencies out of `octavo/` — the stdlib-only constraint is
+  deliberate (it's what keeps `setup.sh` simple on the WSL2/Ubuntu deploy
+  target this tool is built for).
+- Adding a new output format? `octavo/backends/base.py` documents the
+  `Backend` interface; `build.py` and `cli.py` should never need to branch
+  on format name — add a new file under `backends/` and register it in
+  `backends/__init__.py::REGISTRY` instead. `octavo/config.py::BACKENDS`
+  needs the new name too.
+- Run the test suite before pushing; a red CI run on a PR is expected to be
+  fixed before it's merged.
+- Small, focused PRs are easier to review than large ones that mix
+  refactors with behavior changes.
+
+## Reporting a bug
+
+Please include: the command you ran, the full error/output, `octavo doctor`
+output, and your pandoc/TeX/Typst versions (`pandoc --version`, etc.) — §10
+of the README ("What is tested, and what to check yourself") says which parts
+are covered by the test suite and which aren't.

octavo_kit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Takahiro Yoshida
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.