pkgdx 0.5.0rc1__tar.gz

pkgdx-0.5.0rc1/.gitignore

@@ -0,0 +1,48 @@
+# Python bytecode
+__pycache__/
+*.py[cod]
+
+# uv — virtual environment
+.venv/
+.uv-cache/
+
+# hatchling — build output
+dist/
+src/*.egg-info/
+
+# pytest — test cache
+.pytest_cache/
+
+# Coverage.py — reports and data
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# mypy — type-check cache
+.mypy_cache/
+
+# Ruff — lint/format cache
+.ruff_cache/
+
+# prek — pre-commit hook cache
+.prek/
+
+# macOS — filesystem metadata
+.DS_Store
+
+# Windows — filesystem metadata
+Thumbs.db
+ehthumbs.db
+
+# VSCode - settings
+.vscode/
+
+# ICM
+ICM/**/output/*
+!ICM/**/output/.gitkeep
+
+# skill-creator — eval workspaces
+.claude/skills/*-workspace/
+
+.mcp.json

pkgdx-0.5.0rc1/CHANGELOG.md

@@ -0,0 +1,200 @@
+<!-- pyml disable MD024 -->
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+> [!NOTE]
+>
+> - `[SemVer] - yyyy-mm-dd` or `[Unreleased]` for release heading.
+> - `Added` for new features.
+> - `Changed` for changes in existing functionality.
+> - `Deprecated` for soon-to-be removed features.
+> - `Removed` for now removed features.
+> - `Fixed` for any bug fixes.
+> - `Security` in case of vulnerabilities.
+
+## [Unreleased]
+
+### Added
+
+- Releases are published to PyPI via Trusted Publishing, after the GitLab Package Registry.
+- User config directory: `ruff.toml`, `mypy.ini`, `pymarkdown.toml` and `hooks.toml` are read from
+  `%APPDATA%\pkgdx` on Windows, or `$XDG_CONFIG_HOME/pkgdx` (else `~/.config/pkgdx`) elsewhere.
+  Each file falls back to the bundled one. `PKGDX_CONFIG_DIR` overrides the directory and fails
+  with exit code 1 when it is not an existing directory.
+- `pkgdx config` shows the user config directory and the source (user or bundled) of each file.
+  `pkgdx config --export` copies the bundled files into the user config directory without
+  overwriting existing files.
+
+### Changed
+
+- Release tag pipelines run lint and tests before the package is built and published.
+- pkgdx's own `secrets` hook in `prek.toml` runs `pkgdx-secrets-hook` instead of
+  `detect-secrets-hook` directly.
+
+### Fixed
+
+- `pkgdx-secrets` hook and `.secrets.baseline` creation run `detect-secrets` in Python UTF-8 mode
+  (`PYTHONUTF8=1`), matching Linux CI. On Windows, UTF-8 files with characters that cp1252 cannot
+  decode (e.g. Rich's heavy box-drawing `━`) were silently skipped. Windows users may see new
+  findings and should audit or refresh their `.secrets.baseline`.
+
+## [0.4.1] - 2026-10-16
+
+### Changed
+
+- Disabled `plugins.table-column-style.enabled` to mitigate [MD060 false positives](https://github.com/jackdewinter/pymarkdown/issues/1698).
+
+## [0.4.0] - 2026-09-26
+
+### Added
+
+- CI clean-tree and wheel-name guards in `build-package-job` for tag builds.
+
+### Changed
+
+- Added `{ git = { commit = true, tags = true } }` to `cache-keys` for uv.
+- Added `maintainers`, `keywords` and `Documentation` URL to project metadata.
+- Declared explicit sdist `include` and wheel `packages` build targets.
+
+### Fixed
+
+- Added `dist_name = "pkgdx"` to `[tool.hatch.version.raw-options]`, enabling
+  `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PKGDX` to work correctly in CI/CD context.
+- `pkgdx-typing` hook defaults to checking the project (`files = .`, tests excluded) instead of
+  failing with "Missing target".
+- `pkgdx-markdown` hook passes `--continue-on-error`, so a PyMarkdown tokenizer crash fails only the
+  affected file (named in the output) instead of aborting the whole scan.
+
+## [0.3.0] - 2026-09-18
+
+### Added
+
+- New documentation for project standards & toolchain guidance ([`docs/`](docs/)).
+- Custom argparse help formatter (`_core.CLIGFormatter`).
+- Custom argparse.ArgumentParser class `CLIArgumentParser` with rich error formatting.
+- Concise help display on empty CLI command (`pkgdx`).
+- A new CLI version option - `-v` or `--version`.
+
+### Changed
+
+- Excluded `.venv` from `detect-secrets` scan in `secrets-baseline` Justfile recipe.
+- Made `pkgdx-typing` (mypy) hook output verbose and local only in bundled Prek config.
+- Primary CLI output is now on STDOUT.
+- Logs, errors, progress and other diagnostic metadata is now on STDERR.
+- CLI verbosity options (`-v` or `--verbose`) have been replaced with `-d` and `--debug`.
+- `pkgdx init` progress is now a multi-task checklist with a spinner, full-width overall bar, MofN
+  and elapsed   time.
+
+### Removed
+
+- `tryceratops` [TRY003](https://docs.astral.sh/ruff/rules/raise-vanilla-args/) rule was removed
+  due to false positives (builtin exceptions like `ValueError` & `TypeError`).
+
+### Fixed
+
+- Removed `types_or: ["python", "pyi"]` constraint from `pkgdx-secrets` hook, which defeated secret
+  detection.
+- GitLab CI no longer creates a duplicate push pipeline when an MR is already open.
+
+## [0.2.0] - 2026-08-06
+
+### Removed
+
+- AXI CLI & MCP server extracted to [`venv-axi`](https://github.com/andyrids/venv-axi) package.
+
+## [0.1.0] - 2026-08-04
+
+### Added
+
+- AXI CLI `find --package <package>` indexes a package on a miss, then re-searches.
+- AXI CLI `--refresh` flag on `show`, `find`, `tree` & `inspect`, rebuilding a stale symbol graph.
+- AXI CLI `inspect --docstring` flag for complete docstring bodies.
+- AXI MCP `help[]` footers, and `docstring`/`package` parameters, for CLI parity.
+- TOON token-efficiency benchmark.
+
+### Changed
+
+- AXI `find` results are now deterministically ranked.
+- AXI symbol graph schema v4.
+- AXI failed signature introspection now reports `(signature unavailable)`.
+
+### Fixed
+
+- AXI `inherits` silently returned `count: 0` for re-exported classes.
+- AXI `setup` registered an unstartable MCP server without `fastmcp`.
+- AXI `serve` misreported any runtime `ImportError` as a missing `pkgdx[axi]` extra.
+
+## [0.1.0rc8] - 2026-07-31
+
+### Added
+
+- AXI CLI `inherits <qualified_name>` command.
+
+### Changed
+
+- Renamed the canonical standards CLI subcommand `setup` to `init`.
+- Moved standards & AXI CLI to separate subpackages; `axi`, `standards`.
+- Clearer AXI CLI `show` & `inspect` help text.
+- More consistant AXI CLI `help[]` footers on empty results.
+- AXI CLI `inspect` command now accepts bare module names.
+- `CLIContext.console` docstring note on relevance to `standards` subpackage.
+
+### Fixed
+
+- AXI CLI `show` & `inspect` raw-traceback on unimportable names.
+- AXI CLI symbols mis-attributed to the wrong module.
+- AXI CLI silent errors on incorrect names passed to `list` & `find` commands.
+
+## [0.1.0rc7] - 2026-07-29
+
+### Added
+
+- `axi` (`pkgdx-axi`) - an Agent eXperience Interface (AXI).
+  - Provides a CLI & MCP interface.
+  - Fetches venv package metadata for a consuming repo.
+  - Fetches public API/docstring introspection.
+  - Output uses a token-efficient TOON format.
+  - A `setup` command installs ambient context (`AGENTS.md`, `.vscode/mcp.json`, `.mcp.json`).
+- `axi` symbol introspection is now backed by a recursive, SQLite-backed graph store.
+  - Per-project, version-hash-keyed on-disk caching for introspection results.
+
+### Changed
+
+- `pkgdx setup` now validates the consumer `prek.toml` shape at parse time.
+- Dataclass serialization is now stdlib-driven and field-agnostic.
+- TOON table encoding now defaults to a pipe (`|`) delimiter mitigating comma-containing values.
+
+### Fixed
+
+- Introspection no longer crashes (`sqlite3.IntegrityError`) on `__module__` present, but `None`.
+- A crash partway through building the symbol cache now invalidates it for future runs.
+
+## [0.1.0rc6] - 2026-07-14
+
+### Added
+
+- Rich progress bar to the `setup` command, tracking the setup stages.
+- Automatic disabling of the progress bar in non-TTY environments.
+- Render log messages above the live progress display.
+
+### Fixed
+
+- Unit tests for `setup` progress now configure logging before exercising `_setup_progress()`.
+
+## [0.1.0rc5] - 2026-07-10
+
+### Added
+
+- CLI setup script for automated project configuration.
+- `--reset` option for CLI setup script.
+- Detect missing hooks based on pkgdx config.
+- Build & publish to GitLab package registry.
+- Unit tests.
+
+### Fixed
+
+- Updated with correct Prek `update` command.

pkgdx-0.5.0rc1/COPYRIGHT

@@ -0,0 +1,15 @@
+Copyright 2026 Andrew Ridyard
+
+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.
+
+SPDX-License-Identifier: Apache-2.0

pkgdx-0.5.0rc1/LICENSE

@@ -0,0 +1,201 @@
+                                 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.