There is a newer version of the record available.

Published March 14, 2026 | Version v1.0.1

akkapros v1.0.1: Akkadian Prosody Toolkit

Authors/Creators

Description

v1.0.1 — Documentation & packaging fixes

Release date: 2026-03-14

Summary

Patch release that fixes documentation rendering and CLI startup behavior, and adds packaging helpers and project records to improve reproducible distribution.

Highlights

  • Fixed

    • UTF-8 and rendering issues in multiple documentation files.
    • CLI startup banner regression; restored consistent --version output across all CLI entry points.
  • Added

    • CITATION.cff, SUPPORT.md, CONTRIBUTING.md, issue templates, SHOWCASE.md, and .gitattributes.
    • Packaging helpers: scripts/sync_docs.py (Python-only sync) and scripts/build_package.py (pre-build wrapper).
    • Architectural Decision Records (MADR bootstrap) under docs/adr/ (15 ADRs documenting key design choices).
  • Docs & Packaging

    • Package-level documentation mirror synced to src/akkapros/docs/ and included in sdist/wheel via tool.setuptools.package-data.
    • Centralized package metadata at src/akkapros/__init__.py (__version__ = "1.0.1") for consistent CLI --version outputs.
    • Reverted an experimental PEP 517 backend approach; packaging uses setuptools.build_meta and the provided build wrapper.

Upgrade notes

  • This is a doc/packaging patch only — there are no API or CLI behavioral changes that should break scripts. Upgrading is safe:
pip install --upgrade akkapros

If you build from source, run the included sync step before building (the wrapper does this automatically):

python scripts/build_package.py

Files changed / added (high level)

  • CHANGELOG.md (updated with release notes for v1.0.1)
  • pyproject.toml (version = "1.0.1")
  • src/akkapros/__init__.py (centralized __version__ metadata)
  • scripts/sync_docs.py, scripts/build_package.py
  • docs/adr/ (15 MADR files)

Files of interest

  • Changelog: CHANGELOG.md
  • Package version: src/akkapros/__init__.py
  • Docs sync: scripts/sync_docs.py
  • Build wrapper: scripts/build_package.py
  • ADRs: docs/adr/

If you want I can create the git tag v1.0.1, run the build, and prepare the GitHub Release (I will only push or publish with your explicit confirmation).

Notes

If you use this software in your research, please cite it as below.

Files

samuelkabak/akkapros-v1.0.1.zip

Files (376.7 kB)

Name Size Download all
md5:313c46053d3284a4125eaa7357df6f39
376.7 kB Preview Download

Additional details

Related works