bijux-cli 0.1.1__tar.gz → 0.1.2__tar.gz

{bijux_cli-0.1.1 → bijux_cli-0.1.2}/.gitignore

@@ -142,3 +142,7 @@ artifacts/
 artifacts
 .cache
 changelog.d/*.md
+docs/reference
+docs/reference/
+
+

{bijux_cli-0.1.1 → bijux_cli-0.1.2}/CHANGELOG.md

@@ -23,7 +23,37 @@ This project adheres to [Semantic Versioning](https://semver.org) and the
 
 <!-- towncrier start -->
 
+<a id="v0-1-2"></a>
+## [0.1.2] – 2025-08-17
+
+### Added
+* **New Documentation Engine:** Introduced a new modular documentation builder in `scripts/docs_builder/` that replaces the previous helper script.
+* **CI Artifact Pages:** The documentation site now automatically generates detailed pages for all CI artifacts, including tests, linting, code quality, security, API tests, SBOMs, and citation files.
+* **Release Evidence:** The `publish` workflow now downloads all artifacts from the `CI` run, packages them as `evidence/*.tar.gz` bundles, and attaches them to the GitHub Release for traceability.
+* **Build Hygiene:** Makefiles now enforce a "hygienic" build process, ensuring all temporary files, caches, and build outputs are stored under the `artifacts/` directory to prevent root directory pollution.
+
+### Changed
+* **CI/CD Overhaul:**
+    * The `ci.yml` workflow now uploads each category of artifact separately for better organization and downstream consumption.
+    * The `docs.yml` workflow now waits for the main `CI` run to complete, downloads all artifacts, and uses them to build a data-rich documentation site.
+    * The `publish.yml` workflow has been streamlined and made more robust, removing the optional "wait for docs" step and improving tag detection.
+* **Documentation Content:** All top-level Markdown documents (`README.md`, `USAGE.md`, `TESTS.md`, `TOOLING.md`, `CONTRIBUTING.md`, etc.) have been significantly rewritten and expanded with tables of contents, `back-to-top` links, and cross-references to the new artifact pages.
+* **Build System:**
+    * All `Makefile` modules have been refactored to use the new hygienic `artifacts/` directory structure for outputs and caches.
+    * `tox.ini` has been updated to align with the new Makefile targets and to run a comprehensive suite of checks for the `py311` environment, mirroring the full CI validation process.
+* **API Schema:** The OpenAPI `schema.yaml` has been improved with stricter validation (`additionalProperties: false`), better descriptions, response links, and more detailed examples.
+* **Source Code:** Refactored async handling in `src/bijux_cli/api.py` and improved type safety across multiple modules by removing `pyright: ignore` comments and adding explicit `cast` calls where necessary.
+
+### Fixed
+* **Type Safety:** Resolved numerous previously ignored type errors throughout the codebase and test suite.
+* **API Endpoint Logic:** Corrected the item update logic in `src/bijux_cli/httpapi.py` by removing a faulty check for duplicate names that was causing incorrect 409 Conflict errors.
+* **Test Suite:** Improved the stability and correctness of E2E tests by enhancing golden file comparisons and fixing brittle assertions.
+
+[Back to top](#top)
+
+
 <a id="v0-1-1"></a>
+
 ## [0.1.1] – 2025-08-14
 
 ### Added
@@ -62,6 +92,7 @@ This project adheres to [Semantic Versioning](https://semver.org) and the
 ---
 
 <a id="v0-1-0"></a>
+
 ## [0.1.0] – 2025-08-12
 
 ### Added

{bijux_cli-0.1.1 → bijux_cli-0.1.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: bijux-cli
-Version: 0.1.1
+Version: 0.1.2
 Summary: Lean, plug-in-driven CLI kernel
 Project-URL: Homepage, https://github.com/bijux/bijux-cli
 Project-URL: Repository, https://github.com/bijux/bijux-cli.git
 Project-URL: Bug Tracker, https://github.com/bijux/bijux-cli/issues
 Project-URL: Documentation, https://bijux.github.io/bijux-cli/
-Project-URL: Changelog, https://bijux.github.io/bijux-cli/changelog/
+Project-URL: Changelog, https://bijux.github.io/bijux-cli/changelog
 Project-URL: Discussions, https://github.com/bijux/bijux-cli/discussions
 Author-email: Bijan Mousavi <mousavi.bijan@gmail.com>
 License: MIT License
@@ -72,7 +72,7 @@ Requires-Dist: anyio<5.0,>=4.4.0; extra == 'dev'
 Requires-Dist: bandit<2.0,>=1.7.10; extra == 'dev'
 Requires-Dist: build<2.0,>=1.0.3; extra == 'dev'
 Requires-Dist: codespell<3.0,>=2.3.0; extra == 'dev'
-Requires-Dist: commitizen<4.0,>=3.21.0; extra == 'dev'
+Requires-Dist: commitizen<5.0,>=4.0.0; extra == 'dev'
 Requires-Dist: cosmic-ray>=4.0.0; extra == 'dev'
 Requires-Dist: deptry<1.0,>=0.10.0; extra == 'dev'
 Requires-Dist: hypothesis-jsonschema<1.0,>=0.23.0; extra == 'dev'
@@ -89,13 +89,13 @@ Requires-Dist: mkdocs-minify-plugin<1.0,>=0.7; extra == 'dev'
 Requires-Dist: mkdocs-redirects<2.0,>=1.2; extra == 'dev'
 Requires-Dist: mkdocs<2.0,>=1.6.1; extra == 'dev'
 Requires-Dist: mkdocstrings[python]<1.0,>=0.26.1; extra == 'dev'
-Requires-Dist: mutmut<3.0,>=2.1.0; extra == 'dev'
+Requires-Dist: mutmut>=3.0; extra == 'dev'
 Requires-Dist: mypy<2.0,>=1.11.2; extra == 'dev'
 Requires-Dist: openapi-spec-validator<1.0,>=0.7.1; extra == 'dev'
 Requires-Dist: pexpect<5.0,>=4.8.0; extra == 'dev'
 Requires-Dist: pip-audit<3.0,>=2.7.3; extra == 'dev'
-Requires-Dist: prance<1.0,>=0.22.0; extra == 'dev'
-Requires-Dist: pre-commit<4.0,>=3.8.0; extra == 'dev'
+Requires-Dist: prance>=25.4.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.0; extra == 'dev'
 Requires-Dist: pydocstyle<7.0,>=6.2.1; extra == 'dev'
 Requires-Dist: pyright<2.0,>=1.1.320; extra == 'dev'
 Requires-Dist: pytest-asyncio<2.0,>=1.0.0; extra == 'dev'
@@ -105,14 +105,15 @@ Requires-Dist: pytest-rerunfailures<14.0,>=13.0; extra == 'dev'
 Requires-Dist: pytest-timeout<3.0,>=2.4.0; extra == 'dev'
 Requires-Dist: pytest<9.0,>=8.4.1; extra == 'dev'
 Requires-Dist: pytype>=2024.10.11; extra == 'dev'
-Requires-Dist: radon<6.0,>=5.1.0; extra == 'dev'
+Requires-Dist: radon>=6.0.0; extra == 'dev'
 Requires-Dist: reuse<6.0.0,>=4.0.0; extra == 'dev'
 Requires-Dist: ruff<1.0,>=0.6.8; extra == 'dev'
-Requires-Dist: schemathesis<4.0,>=3.16.0; extra == 'dev'
+Requires-Dist: schemathesis<5.0,>=4.0; extra == 'dev'
 Requires-Dist: towncrier<25.0,>=23.0; extra == 'dev'
 Requires-Dist: twine<7.0,>=6.1.0; extra == 'dev'
 Requires-Dist: types-colorama<1.0,>=0.0.14; extra == 'dev'
 Requires-Dist: types-orjson<4.0,>=3.6.0; extra == 'dev'
+Requires-Dist: types-pexpect<5.0,>4.9.0; extra == 'dev'
 Requires-Dist: types-psutil<7.0,>=6.0.0; extra == 'dev'
 Requires-Dist: types-pyyaml<7.0,>=6.0.12; extra == 'dev'
 Requires-Dist: typing-extensions<5.0,>=4.5.0; extra == 'dev'
@@ -132,8 +133,10 @@ Description-Content-Type: text/markdown
 [![CI Status](https://github.com/bijux/bijux-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/bijux/bijux-cli/actions)
 
 > **At a glance:** Plugin-driven • deterministic flags • DI for testability • REPL • structured JSON/YAML  
-> **Quality:** **2,600+ tests** across layers with **98%+ coverage**. Multi-version CI. Docs build enforced. No telemetry.
-
+> **Quality:** **2,600+ tests** across layers with **98%+ coverage** (see
+> [Test Artifacts](artifacts/test.md) and
+> <a href="artifacts/test/htmlcov/index.html" target="_blank" rel="noopener">HTML coverage</a>).
+> Multi-version CI. Docs build enforced. No telemetry.
 ---
 
 ## Table of Contents
@@ -430,6 +433,11 @@ make test-unit    # unit tests only
 make test-e2e     # end-to-end tests only
 ```
 
+**Artifacts:** [Test Artifacts](artifacts/test.md) ·
+[JUnit report](artifacts/test.md#junit-xml) ·
+<a href="artifacts/test/htmlcov/index.html" target="_blank" rel="noopener">HTML coverage report</a>
+
+
 [Back to top](#top)
 
 ---
@@ -482,6 +490,9 @@ Track progress and suggest features via [Issues](https://github.com/bijux/bijux-
 * **Security** (private reports): [https://github.com/bijux/bijux-cli/security/advisories/new](https://github.com/bijux/bijux-cli/security/advisories/new)
 * **Tests:** See **[TESTS.md](TESTS.md)**
 * **Project Tree:** See **[PROJECT\_TREE.md](PROJECT_TREE.md)**
+* **Artifacts:** Browse all reports & logs — [index](artifacts/index.md)
+· [Tests](artifacts/test.md) · [Lint](artifacts/lint.md) · [Quality](artifacts/quality.md)
+ · [Security](artifacts/security.md) · [SBOM](artifacts/sbom.md) · [API](artifacts/api.md) · [Citation](artifacts/citation.md)
 
 *When filing issues, include `--debug` output where possible.*
 
@@ -544,7 +555,37 @@ This project adheres to [Semantic Versioning](https://semver.org) and the
 
 <!-- towncrier start -->
 
+<a id="v0-1-2"></a>
+## [0.1.2] – 2025-08-17
+
+### Added
+* **New Documentation Engine:** Introduced a new modular documentation builder in `scripts/docs_builder/` that replaces the previous helper script.
+* **CI Artifact Pages:** The documentation site now automatically generates detailed pages for all CI artifacts, including tests, linting, code quality, security, API tests, SBOMs, and citation files.
+* **Release Evidence:** The `publish` workflow now downloads all artifacts from the `CI` run, packages them as `evidence/*.tar.gz` bundles, and attaches them to the GitHub Release for traceability.
+* **Build Hygiene:** Makefiles now enforce a "hygienic" build process, ensuring all temporary files, caches, and build outputs are stored under the `artifacts/` directory to prevent root directory pollution.
+
+### Changed
+* **CI/CD Overhaul:**
+    * The `ci.yml` workflow now uploads each category of artifact separately for better organization and downstream consumption.
+    * The `docs.yml` workflow now waits for the main `CI` run to complete, downloads all artifacts, and uses them to build a data-rich documentation site.
+    * The `publish.yml` workflow has been streamlined and made more robust, removing the optional "wait for docs" step and improving tag detection.
+* **Documentation Content:** All top-level Markdown documents (`README.md`, `USAGE.md`, `TESTS.md`, `TOOLING.md`, `CONTRIBUTING.md`, etc.) have been significantly rewritten and expanded with tables of contents, `back-to-top` links, and cross-references to the new artifact pages.
+* **Build System:**
+    * All `Makefile` modules have been refactored to use the new hygienic `artifacts/` directory structure for outputs and caches.
+    * `tox.ini` has been updated to align with the new Makefile targets and to run a comprehensive suite of checks for the `py311` environment, mirroring the full CI validation process.
+* **API Schema:** The OpenAPI `schema.yaml` has been improved with stricter validation (`additionalProperties: false`), better descriptions, response links, and more detailed examples.
+* **Source Code:** Refactored async handling in `src/bijux_cli/api.py` and improved type safety across multiple modules by removing `pyright: ignore` comments and adding explicit `cast` calls where necessary.
+
+### Fixed
+* **Type Safety:** Resolved numerous previously ignored type errors throughout the codebase and test suite.
+* **API Endpoint Logic:** Corrected the item update logic in `src/bijux_cli/httpapi.py` by removing a faulty check for duplicate names that was causing incorrect 409 Conflict errors.
+* **Test Suite:** Improved the stability and correctness of E2E tests by enhancing golden file comparisons and fixing brittle assertions.
+
+[Back to top](#top)
+
+
 <a id="v0-1-1"></a>
+
 ## [0.1.1] – 2025-08-14
 
 ### Added
@@ -583,6 +624,7 @@ This project adheres to [Semantic Versioning](https://semver.org) and the
 ---
 
 <a id="v0-1-0"></a>
+
 ## [0.1.0] – 2025-08-12
 
 ### Added

{bijux_cli-0.1.1 → bijux_cli-0.1.2}/README.md

@@ -10,8 +10,10 @@
 [![CI Status](https://github.com/bijux/bijux-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/bijux/bijux-cli/actions)
 
 > **At a glance:** Plugin-driven • deterministic flags • DI for testability • REPL • structured JSON/YAML  
-> **Quality:** **2,600+ tests** across layers with **98%+ coverage**. Multi-version CI. Docs build enforced. No telemetry.
-
+> **Quality:** **2,600+ tests** across layers with **98%+ coverage** (see
+> [Test Artifacts](artifacts/test.md) and
+> <a href="artifacts/test/htmlcov/index.html" target="_blank" rel="noopener">HTML coverage</a>).
+> Multi-version CI. Docs build enforced. No telemetry.
 ---
 
 ## Table of Contents
@@ -308,6 +310,11 @@ make test-unit    # unit tests only
 make test-e2e     # end-to-end tests only
 ```
 
+**Artifacts:** [Test Artifacts](artifacts/test.md) ·
+[JUnit report](artifacts/test.md#junit-xml) ·
+<a href="artifacts/test/htmlcov/index.html" target="_blank" rel="noopener">HTML coverage report</a>
+
+
 [Back to top](#top)
 
 ---
@@ -360,6 +367,9 @@ Track progress and suggest features via [Issues](https://github.com/bijux/bijux-
 * **Security** (private reports): [https://github.com/bijux/bijux-cli/security/advisories/new](https://github.com/bijux/bijux-cli/security/advisories/new)
 * **Tests:** See **[TESTS.md](TESTS.md)**
 * **Project Tree:** See **[PROJECT\_TREE.md](PROJECT_TREE.md)**
+* **Artifacts:** Browse all reports & logs — [index](artifacts/index.md)
+· [Tests](artifacts/test.md) · [Lint](artifacts/lint.md) · [Quality](artifacts/quality.md)
+ · [Security](artifacts/security.md) · [SBOM](artifacts/sbom.md) · [API](artifacts/api.md) · [Citation](artifacts/citation.md)
 
 *When filing issues, include `--debug` output where possible.*
 

{bijux_cli-0.1.1 → bijux_cli-0.1.2}/pyproject.toml

@@ -66,6 +66,7 @@ dev = [
   "types-colorama>=0.0.14,<1.0",
   "types-psutil>=6.0.0,<7.0",
   "typing-extensions>=4.5.0,<5.0",
+  "types-pexpect>4.9.0,<5.0",
 
   "pytest>=8.4.1,<9.0",
   "pytest-cov>=6.2.1,<7.0",
@@ -83,7 +84,7 @@ dev = [
   "codespell>=2.3.0,<3.0",
   "pyright>=1.1.320,<2.0",
   "pydocstyle>=6.2.1,<7.0",
-  "radon>=5.1.0,<6.0",
+  "radon>=6.0.0",
 
   "vulture>=2.7,<3.0",
   "deptry>=0.10.0,<1.0",
@@ -92,7 +93,7 @@ dev = [
   "build>=1.0.3,<2.0",
   "bandit>=1.7.10,<2.0",
   "pip-audit>=2.7.3,<3.0",
-  "commitizen>=3.21.0,<4.0",
+  "commitizen>=4.0.0,<5.0",
 
   "interrogate>=1.7.0,<2.0",
   "mkdocs>=1.6.1,<2.0",
@@ -107,17 +108,17 @@ dev = [
   "mkdocs-glightbox>=0.3,<1.0",
   "mkdocs-material[imaging]>=9.5.39,<10.0",
 
-  "prance>=0.22.0,<1.0",
+  "prance>=25.4.0.0",
   "openapi-spec-validator>=0.7.1,<1.0",
-  "schemathesis>=3.16.0,<4.0",
+  "schemathesis>=4.0,<5.0",
   "anyio>=4.4.0,<5.0",
   "uvicorn>=0.30.1,<1.0",
 
-  "pre-commit>=3.8.0,<4.0",
+  "pre-commit>=4.0",
   "twine>=6.1.0,<7.0",
   "towncrier>=23.0,<25.0",
 
-  "mutmut>=2.1.0,<3.0",
+  "mutmut>=3.0",
   "cosmic-ray>=4.0.0",
 ]
 
@@ -129,7 +130,7 @@ bijux = "bijux_cli.__main__:main"
 "Repository" = "https://github.com/bijux/bijux-cli.git"
 "Bug Tracker" = "https://github.com/bijux/bijux-cli/issues"
 "Documentation" = "https://bijux.github.io/bijux-cli/"
-"Changelog" = "https://bijux.github.io/bijux-cli/changelog/"
+"Changelog" = "https://bijux.github.io/bijux-cli/changelog"
 "Discussions" = "https://github.com/bijux/bijux-cli/discussions"
 
 # --8<-- [start:bijux]

bijux_cli-0.1.1/scripts/README.md

@@ -1,196 +0,0 @@
-# Scripts
-<a id="top"></a>
-
-A small collection of **purpose-built developer utilities** for code hygiene, documentation automation, and release workflow integration.
-
----
-
-## Table of Contents
-
-- [Directory](#directory)
-- [Comment Harvester (`helper_comments.py`)](#comment-harvester)
-- [MkDocs API & Navigation Generator (`helper_mkdocs.py`)](#mkdocs-api--navigation-generator)
-- [Commit Hook – Changelog Fragment Generator (`git-hooks/prepare-commit-msg`)](#commit-hook--changelog-fragment-generator)
-- [Towncrier Guard (`check-towncrier-fragment.sh`)](#towncrier-guard)
-- [Workflow Philosophy](#workflow-philosophy)
-
-[Back to top](#top)
-
----
-
-<a id="directory"></a>
-
-## Directory
-
-```
-
-scripts/
-├── README.md
-├── check-towncrier-fragment.sh
-├── git-hooks/
-│   └── prepare-commit-msg
-├── helper\_comments.py
-└── helper\_mkdocs.py
-
-````
-
-[Back to top](#top)
-
----
-
-<a id="comment-harvester"></a>
-
-## Comment Harvester (`helper_comments.py`)
-
-Scans a codebase for **all lines containing `#`** (including `# noqa`, `# type: ignore`, and TODO/FIXME notes).
-
-**Why?**  
-Build a **baseline** for linter/typing ignore rules and periodically triage technical debt.
-
-**Usage**
-
-```bash
-python scripts/helper_comments.py src -o comments.txt -e .py .pyi
-````
-
-**Sample output**
-
-```
-src/example.py
-12: def foo():  # noqa: E999
-47: # TODO: refactor
-```
-
-**Notes**
-
-* Any `#` is treated as a comment (includes shebangs and inline `#` inside strings).
-* Skips unreadable files.
-* Respects `--ext` filter.
-* Prints a summary path: `Violation lines written to <output>`.
-
-[Back to top](#top)
-
----
-
-<a id="mkdocs-api--navigation-generator"></a>
-
-## MkDocs API & Navigation Generator (`helper_mkdocs.py`)
-
-Runs via **mkdocs-gen-files** during MkDocs builds to keep docs in sync.
-
-**What it does**
-
-1. Copies root docs into the site with safe link rewrites:
-
-   * `README.md` → `docs/index.md`
-   * `USAGE.md` → `docs/usage.md`
-   * `TESTS.md` → `docs/tests.md`
-   * `PROJECT_TREE.md` → `docs/project_tree.md`
-2. Ensures a hidden top anchor on copied pages.
-3. Generates **API reference** pages for `src/bijux_cli/**.py` (mkdocstrings).
-4. Creates per-package `reference/**/index.md`.
-5. Builds `nav.md` with **Home / User Guide / Project Tree / Tests / API / Changelog / ADRs / Community**.
-
-**MkDocs config snippet**
-
-```yaml
-plugins:
-  - gen-files:
-      scripts:
-        - scripts/helper_mkdocs.py
-  - literate-nav
-  - mkdocstrings
-```
-
-**Local preview**
-
-```bash
-mkdocs serve    # preview
-mkdocs build    # static site
-```
-
-[Back to top](#top)
-
----
-
-<a id="commit-hook--changelog-fragment-generator"></a>
-
-## Commit Hook – Changelog Fragment Generator (`git-hooks/prepare-commit-msg`)
-
-A **Git `prepare-commit-msg` hook** that auto-creates a Towncrier fragment from a **Conventional Commit** subject.
-
-**Example**
-
-```
-feat(api): add streaming support
-```
-
-Produces (timestamped):
-
-```
-changelog.d/1691940245.feature.md
-```
-
-**Type mapping**
-
-* `feat` → `feature`
-* `fix` → `bugfix`
-* `refactor`/`docs`/`style`/`chore` → `misc`
-* others → `misc`
-
-**Install**
-
-```bash
-# from repo root
-chmod +x scripts/git-hooks/prepare-commit-msg
-ln -sf ../../scripts/git-hooks/prepare-commit-msg .git/hooks/prepare-commit-msg
-make bootstrap   # installs hooks idempotently
-```
-
-[Back to top](#top)
-
----
-
-<a id="towncrier-guard"></a>
-
-## Towncrier Guard (`check-towncrier-fragment.sh`)
-
-Blocks commits of types that **should** have a Towncrier fragment if none is staged.
-
-**Behavior**
-
-* Skips `Merge`, `Revert`, `fixup!`, `squash!`, and `chore: release` subjects.
-* Looks for staged `changelog.d/*.md`.
-* Enforces for common types: `feat`, `fix`, `refactor`, `perf`, `docs`.
-* Allow override with `TOWNCRIER_ALLOW_SKIP=1`.
-
-**Wire it up (pre-commit, commit-msg stage)**
-
-```yaml
-# .pre-commit-config.yaml
-repos:
-  - repo: local
-    hooks:
-      - id: towncrier-guard
-        name: Towncrier fragment required
-        entry: scripts/check-towncrier-fragment.sh
-        language: system
-        stages: [commit-msg]
-```
-
-Alternatively, call it in CI before merge.
-
-[Back to top](#top)
-
----
-
-<a id="workflow-philosophy"></a>
-
-## Workflow Philosophy
-
-* **Automation first** — anything repetitive belongs in a script or hook.
-* **Debt visibility** — helper comments are tracked, triaged, and expire.
-* **Docs in sync** — API/navigation are regenerated automatically at build time.
-* **Release-ready commits** — hooks ensure changelog accuracy.
-
-[Back to top](#top)