index-graph 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- index_graph-1.0.0/.github/workflows/ci.yml +16 -0
- index_graph-1.0.0/.github/workflows/release-artifacts.yml +41 -0
- index_graph-1.0.0/.gitignore +17 -0
- index_graph-1.0.0/AUTHORS.md +1 -0
- index_graph-1.0.0/CHANGELOG.md +51 -0
- index_graph-1.0.0/CONTRIBUTING.md +12 -0
- index_graph-1.0.0/LICENSE +21 -0
- index_graph-1.0.0/PKG-INFO +148 -0
- index_graph-1.0.0/README.md +125 -0
- index_graph-1.0.0/RELEASE.md +16 -0
- index_graph-1.0.0/USAGE.md +332 -0
- index_graph-1.0.0/docs/superpowers/plans/2026-06-18-productize-core-phase1.md +1249 -0
- index_graph-1.0.0/docs/superpowers/plans/2026-06-23-graph-viz-dashboard.md +1698 -0
- index_graph-1.0.0/docs/superpowers/plans/2026-06-23-repo-graph-context-engine.md +1488 -0
- index_graph-1.0.0/docs/superpowers/specs/2026-06-18-productize-core-design.md +416 -0
- index_graph-1.0.0/docs/superpowers/specs/2026-06-23-repo-graph-context-engine-design.md +327 -0
- index_graph-1.0.0/example.index.toml +21 -0
- index_graph-1.0.0/examples/demo.py +81 -0
- index_graph-1.0.0/pyproject.toml +41 -0
- index_graph-1.0.0/scripts/dogfood_recovery.py +53 -0
- index_graph-1.0.0/scripts/viz_dogfood.py +30 -0
- index_graph-1.0.0/src/index_graph/__init__.py +16 -0
- index_graph-1.0.0/src/index_graph/__main__.py +4 -0
- index_graph-1.0.0/src/index_graph/classify.py +29 -0
- index_graph-1.0.0/src/index_graph/cli.py +194 -0
- index_graph-1.0.0/src/index_graph/config.py +124 -0
- index_graph-1.0.0/src/index_graph/context/__init__.py +1 -0
- index_graph-1.0.0/src/index_graph/context/pack.py +98 -0
- index_graph-1.0.0/src/index_graph/gitmeta.py +47 -0
- index_graph-1.0.0/src/index_graph/graph/__init__.py +4 -0
- index_graph-1.0.0/src/index_graph/graph/build.py +127 -0
- index_graph-1.0.0/src/index_graph/graph/edges.py +76 -0
- index_graph-1.0.0/src/index_graph/graph/resolvers/__init__.py +5 -0
- index_graph-1.0.0/src/index_graph/graph/resolvers/base.py +28 -0
- index_graph-1.0.0/src/index_graph/graph/resolvers/javascript.py +64 -0
- index_graph-1.0.0/src/index_graph/graph/resolvers/python.py +113 -0
- index_graph-1.0.0/src/index_graph/graph/roles.py +65 -0
- index_graph-1.0.0/src/index_graph/graph/walk.py +28 -0
- index_graph-1.0.0/src/index_graph/model.py +67 -0
- index_graph-1.0.0/src/index_graph/scan.py +116 -0
- index_graph-1.0.0/src/index_graph/viz/__init__.py +12 -0
- index_graph-1.0.0/src/index_graph/viz/charts.py +49 -0
- index_graph-1.0.0/src/index_graph/viz/html.py +99 -0
- index_graph-1.0.0/src/index_graph/viz/layout.py +210 -0
- index_graph-1.0.0/src/index_graph/viz/manifest.py +43 -0
- index_graph-1.0.0/src/index_graph/viz/mermaid.py +70 -0
- index_graph-1.0.0/src/index_graph/viz/svg.py +70 -0
- index_graph-1.0.0/src/index_graph/viz/theme.py +62 -0
- index_graph-1.0.0/tests/fixtures/js-app/package.json +1 -0
- index_graph-1.0.0/tests/fixtures/js-app/src/main.ts +3 -0
- index_graph-1.0.0/tests/fixtures/js-lib/index.js +2 -0
- index_graph-1.0.0/tests/fixtures/js-lib/package.json +1 -0
- index_graph-1.0.0/tests/fixtures/py-app/py_app/cli.py +5 -0
- index_graph-1.0.0/tests/fixtures/py-app/pyproject.toml +7 -0
- index_graph-1.0.0/tests/fixtures/py-lib/py_lib/__init__.py +1 -0
- index_graph-1.0.0/tests/fixtures/py-lib/pyproject.toml +4 -0
- index_graph-1.0.0/tests/test_build.py +28 -0
- index_graph-1.0.0/tests/test_classify.py +22 -0
- index_graph-1.0.0/tests/test_cli.py +37 -0
- index_graph-1.0.0/tests/test_cli_subcommands.py +47 -0
- index_graph-1.0.0/tests/test_config.py +81 -0
- index_graph-1.0.0/tests/test_edges.py +79 -0
- index_graph-1.0.0/tests/test_example_config.py +11 -0
- index_graph-1.0.0/tests/test_gitmeta.py +49 -0
- index_graph-1.0.0/tests/test_model.py +40 -0
- index_graph-1.0.0/tests/test_pack.py +47 -0
- index_graph-1.0.0/tests/test_rename_guardrail.py +32 -0
- index_graph-1.0.0/tests/test_resolver_javascript.py +28 -0
- index_graph-1.0.0/tests/test_resolver_python.py +35 -0
- index_graph-1.0.0/tests/test_roles.py +34 -0
- index_graph-1.0.0/tests/test_scan.py +71 -0
- index_graph-1.0.0/tests/test_version.py +5 -0
- index_graph-1.0.0/tests/test_viz_boundary.py +34 -0
- index_graph-1.0.0/tests/test_viz_charts.py +38 -0
- index_graph-1.0.0/tests/test_viz_cli.py +106 -0
- index_graph-1.0.0/tests/test_viz_editorial.py +32 -0
- index_graph-1.0.0/tests/test_viz_html.py +93 -0
- index_graph-1.0.0/tests/test_viz_layout.py +44 -0
- index_graph-1.0.0/tests/test_viz_layout_geometry.py +100 -0
- index_graph-1.0.0/tests/test_viz_manifest.py +42 -0
- index_graph-1.0.0/tests/test_viz_mermaid.py +68 -0
- index_graph-1.0.0/tests/test_viz_svg.py +55 -0
- index_graph-1.0.0/tests/test_viz_theme.py +25 -0
- index_graph-1.0.0/tests/test_walk.py +31 -0
- index_graph-1.0.0/tests/viz_fixtures.py +62 -0
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
pull_request:
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
test:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
steps:
|
|
11
|
+
- uses: actions/checkout@v5
|
|
12
|
+
- uses: actions/setup-python@v5
|
|
13
|
+
with:
|
|
14
|
+
python-version: "3.12"
|
|
15
|
+
- run: python -m pip install -e ".[test]"
|
|
16
|
+
- run: python -m pytest
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
name: Release Artifacts
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
push:
|
|
6
|
+
tags:
|
|
7
|
+
- 'v*'
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
build:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v5
|
|
14
|
+
- uses: actions/setup-python@v5
|
|
15
|
+
with:
|
|
16
|
+
python-version: '3.11'
|
|
17
|
+
- name: Build and check the package
|
|
18
|
+
run: |
|
|
19
|
+
python -m pip install --upgrade pip
|
|
20
|
+
python -m pip install build twine
|
|
21
|
+
python -m build
|
|
22
|
+
python -m twine check dist/*
|
|
23
|
+
- uses: actions/upload-artifact@v5
|
|
24
|
+
with:
|
|
25
|
+
name: index-graph-dist
|
|
26
|
+
path: dist/*
|
|
27
|
+
|
|
28
|
+
pypi-publish:
|
|
29
|
+
name: Publish to PyPI
|
|
30
|
+
needs: build
|
|
31
|
+
if: startsWith(github.ref, 'refs/tags/v')
|
|
32
|
+
runs-on: ubuntu-latest
|
|
33
|
+
environment: pypi
|
|
34
|
+
steps:
|
|
35
|
+
- uses: actions/download-artifact@v5
|
|
36
|
+
with:
|
|
37
|
+
name: index-graph-dist
|
|
38
|
+
path: dist
|
|
39
|
+
- uses: pypa/gh-action-pypi-publish@release/v1
|
|
40
|
+
with:
|
|
41
|
+
password: ${{ secrets.PYPI_API_TOKEN }}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
__pycache__/
|
|
2
|
+
.pytest_cache/
|
|
3
|
+
.venv/
|
|
4
|
+
env/
|
|
5
|
+
*.pyc
|
|
6
|
+
.idea/
|
|
7
|
+
dist/
|
|
8
|
+
build/
|
|
9
|
+
.ruff_cache/
|
|
10
|
+
.mypy_cache/
|
|
11
|
+
|
|
12
|
+
# local safe-io cache (runtime artifact, never committed)
|
|
13
|
+
.warden-safe-cache/
|
|
14
|
+
.superpowers/
|
|
15
|
+
|
|
16
|
+
# viz dogfood output (runtime artifact, never committed)
|
|
17
|
+
.viz-dogfood-out/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Zain Dana Harper
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 1.0.0
|
|
4
|
+
|
|
5
|
+
Renamed to **index** (`pip install index-graph`, command `index`); flagship release. (Was `workspace-repo-map`.)
|
|
6
|
+
|
|
7
|
+
## 0.4.0
|
|
8
|
+
|
|
9
|
+
- Add `viz` subcommand: render the dependency graph as a self-contained interactive
|
|
10
|
+
HTML dashboard (default), a standalone SVG network graph, or a Mermaid flowchart.
|
|
11
|
+
- `viz --format all` also emits `context.json` and a `context-manifest.json` handoff
|
|
12
|
+
(artifact paths + content hashes) for downstream consumers.
|
|
13
|
+
- Renders are deterministic (byte-identical for identical input) and self-contained
|
|
14
|
+
(no external URLs, no runtime dependencies).
|
|
15
|
+
|
|
16
|
+
## 0.3.0
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
- `graph` subcommand: infer a repo→repo dependency graph from Python and
|
|
20
|
+
JavaScript/TypeScript manifests and source imports. Every edge carries its
|
|
21
|
+
evidence (witnessing file/line + signal kind) and a confidence grade.
|
|
22
|
+
- `context` subcommand: render a synthesis context pack (structural roles +
|
|
23
|
+
relations + extracted prose) with a salience-faithfulness audit and a
|
|
24
|
+
`--focus <repo>` neighborhood closure.
|
|
25
|
+
|
|
26
|
+
### Changed
|
|
27
|
+
- The CLI now uses subcommands (`map`, `graph`, `context`). The previous flat
|
|
28
|
+
invocation (`workspace-repo-map --root ...`) is preserved and dispatches to `map`.
|
|
29
|
+
- Makes generated repository maps portable by default.
|
|
30
|
+
- Replaces absolute local root paths with a root hash prefix.
|
|
31
|
+
- Omits protected remotes and redacts credential-shaped remote URL material.
|
|
32
|
+
|
|
33
|
+
## 0.2.0 - 2026-06-18
|
|
34
|
+
|
|
35
|
+
- Config-driven classification via optional `.repomap.toml` (ordered path-glob rules,
|
|
36
|
+
neutral remote-host fallback). Personal taxonomy moves to user config.
|
|
37
|
+
- Unifies the CLI into a single argument parser; removes the duplicate.
|
|
38
|
+
- Adds a stable public API (`__all__`, `__version__`) and a versioned output
|
|
39
|
+
(`schema_version: 1`); drops the duplicated `relative` field and protected-specific
|
|
40
|
+
counts in favor of generic `class_counts`.
|
|
41
|
+
- Parallelizes per-repo git calls; output remains deterministic.
|
|
42
|
+
- Adds a portable (default) / local output mode and an `annotations` passthrough.
|
|
43
|
+
- Raises the Python floor to 3.11 (stdlib `tomllib`); runtime dependencies stay empty.
|
|
44
|
+
|
|
45
|
+
## 0.1.0 - 2026-06-13
|
|
46
|
+
|
|
47
|
+
- Initial public release candidate.
|
|
48
|
+
- Ships compact JSON repository inventory mapping for multi-repo local
|
|
49
|
+
workspaces.
|
|
50
|
+
- Adds Python package metadata, CI, license, authorship, and contribution
|
|
51
|
+
boundary files.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
## Success Criteria
|
|
4
|
+
|
|
5
|
+
- Public docs and scripts include explicit references to known limitations.
|
|
6
|
+
- No secrets and no em-dash characters in public markdown.
|
|
7
|
+
- Release artifacts are deterministic and reproducible.
|
|
8
|
+
- Tests cover core behavior.
|
|
9
|
+
|
|
10
|
+
## How to Contribute
|
|
11
|
+
|
|
12
|
+
Open PRs with targeted changes and include test coverage for behavior changes.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Zain Dana Harper
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: index-graph
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Compact JSON repository inventory maps for multi-repo workspaces.
|
|
5
|
+
Project-URL: Homepage, https://github.com/HarperZ9/index
|
|
6
|
+
Project-URL: Repository, https://github.com/HarperZ9/index
|
|
7
|
+
Project-URL: Issues, https://github.com/HarperZ9/index/issues
|
|
8
|
+
Author: Zain Dana Harper
|
|
9
|
+
License: MIT
|
|
10
|
+
License-File: AUTHORS.md
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: cli,git,inventory,workspace
|
|
13
|
+
Classifier: Development Status :: 3 - Alpha
|
|
14
|
+
Classifier: Environment :: Console
|
|
15
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Requires-Python: >=3.11
|
|
20
|
+
Provides-Extra: test
|
|
21
|
+
Requires-Dist: pytest>=8; extra == 'test'
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
|
|
24
|
+
# index
|
|
25
|
+
|
|
26
|
+
> **See the shape of any codebase**: a repo-dependency graph + an interactive HTML dashboard, built from real code evidence — zero dependencies.
|
|
27
|
+
|
|
28
|
+
[](LICENSE)
|
|
29
|
+

|
|
30
|
+

|
|
31
|
+
[](https://github.com/HarperZ9/index-graph/actions/workflows/ci.yml)
|
|
32
|
+

|
|
33
|
+
|
|
34
|
+
`index` scans a workspace for Git repositories and renders a **dependency and topology graph** of them — as an interactive self-contained HTML dashboard, layered SVG, Mermaid, and a JSON context manifest. Every edge in the graph carries its own evidence (the file and line that witnesses it, plus a confidence grade). Output is deterministic; nothing to install beyond Python.
|
|
35
|
+
|
|
36
|
+
## 30-second quickstart
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
pip install index-graph
|
|
40
|
+
index viz --root /path/to/your/workspace --format html --out graph.html
|
|
41
|
+
open graph.html # or: start graph.html on Windows
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
That produces a self-contained HTML file with an interactive dashboard: clickable nodes, layered layout, dependency lanes, and summary charts — no server, no assets, nothing to host.
|
|
45
|
+
|
|
46
|
+
To also write the raw JSON manifest:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
index map --root /path/to/your/workspace --output INDEX.json
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## What you get
|
|
53
|
+
|
|
54
|
+
| Output | Command | Description |
|
|
55
|
+
|--------|---------|-------------|
|
|
56
|
+
| **Interactive HTML dashboard** | `index viz --format html` | Self-contained; click nodes, explore layers and charts |
|
|
57
|
+
| **Layered SVG** | `index viz --format svg` | Static vector graph suitable for docs/CI artifacts |
|
|
58
|
+
| **Mermaid diagram** | `index viz --format mermaid` | Paste into GitHub markdown or any Mermaid renderer |
|
|
59
|
+
| **All three at once** | `index viz --format all --out-dir ./out` | Writes `graph.html`, `graph.svg`, `graph.mmd` |
|
|
60
|
+
| **JSON context manifest** | `index map` | Machine-readable inventory: remotes, branches, dirty counts, classification |
|
|
61
|
+
| **Dependency graph (text/JSON)** | `index graph` | Repo→repo edges with evidence; each edge carries its witness |
|
|
62
|
+
| **Context pack (prose + relations)** | `index context` | Synthesis pack: roles, relations, narrative summary |
|
|
63
|
+
|
|
64
|
+
## CLI reference
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
index map [--root ROOT] [--output FILE] [--json] [--config CFG]
|
|
68
|
+
index graph [--root ROOT] [--json]
|
|
69
|
+
index context [--root ROOT] [--focus REPO]
|
|
70
|
+
index viz [--root ROOT] [--format {html,svg,mermaid,all}]
|
|
71
|
+
[--focus REPO] [--no-external] [--out FILE] [--out-dir DIR]
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
`--focus REPO` narrows any render to a single repo's bidirectional dependency neighborhood.
|
|
75
|
+
`--no-external` hides stdlib/third-party nodes, keeping the graph to workspace repos only.
|
|
76
|
+
|
|
77
|
+
## Dependency graph example
|
|
78
|
+
|
|
79
|
+
Running `index viz --root ./my-workspace --format mermaid` produces a Mermaid flowchart where
|
|
80
|
+
workspace repos are rectangular nodes and external dependencies are rounded nodes:
|
|
81
|
+
|
|
82
|
+
```mermaid
|
|
83
|
+
flowchart TD
|
|
84
|
+
n_api["api"]
|
|
85
|
+
n_core["core"]
|
|
86
|
+
n_cli["cli"]
|
|
87
|
+
n_pathlib(("pathlib"))
|
|
88
|
+
n_requests(("requests"))
|
|
89
|
+
n_core --> n_pathlib
|
|
90
|
+
n_api --> n_core
|
|
91
|
+
n_cli --> n_api
|
|
92
|
+
n_cli --> n_requests
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Every `-->` edge in the real output carries the file (and line) that witnesses it.
|
|
96
|
+
|
|
97
|
+
## Configuration
|
|
98
|
+
|
|
99
|
+
Place an optional `.index.toml` at your workspace root to control classification rules,
|
|
100
|
+
which remotes to drop, and parallel worker count:
|
|
101
|
+
|
|
102
|
+
```toml
|
|
103
|
+
# .index.toml — at your workspace root
|
|
104
|
+
[[rule]] # classify repos by workspace-relative path; first match wins
|
|
105
|
+
pattern = "oss/**"
|
|
106
|
+
class = "public"
|
|
107
|
+
|
|
108
|
+
[[rule]]
|
|
109
|
+
pattern = "work/**"
|
|
110
|
+
class = "internal"
|
|
111
|
+
|
|
112
|
+
[scan]
|
|
113
|
+
jobs = 16 # parallel workers
|
|
114
|
+
prune = ["vendor", "target"] # extra dirs to skip (added to the built-in safety set)
|
|
115
|
+
|
|
116
|
+
[privacy]
|
|
117
|
+
omit_origin_classes = ["internal"] # drop remote URLs for repos in these classes
|
|
118
|
+
|
|
119
|
+
[output]
|
|
120
|
+
portable = true # root-relative paths + hashed root (default on)
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
See [`example.index.toml`](example.index.toml) for the full schema and [`USAGE.md`](USAGE.md) for the
|
|
124
|
+
complete flag reference, the importable Python API, and worked examples with expected output.
|
|
125
|
+
|
|
126
|
+
## Guarantees
|
|
127
|
+
|
|
128
|
+
- **Evidence on every edge.** No edge appears in the graph without a file (and line) that witnesses it and a confidence grade (`high` when both a declared dependency and an observed import agree).
|
|
129
|
+
- **Deterministic output.** The same workspace produces the same JSON and renders every time.
|
|
130
|
+
- **Zero runtime dependencies.** Pure Python stdlib; nothing to install beyond Python 3.11+.
|
|
131
|
+
- **Portable maps.** Repository paths are root-relative; the local root is represented by a short hash; credential-shaped strings in remote URLs are always redacted.
|
|
132
|
+
|
|
133
|
+
## Install
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
pip install index-graph
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Or from a checkout:
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
pip install -e .
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
**Zain Dana Harper** — small tools with explicit edges.
|
|
147
|
+
[Portfolio](https://harperz9.github.io) · [HarperZ9](https://github.com/HarperZ9)
|
|
148
|
+
<sub>Built with Claude Code; reviewed, tested, and owned by me.</sub>
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# index
|
|
2
|
+
|
|
3
|
+
> **See the shape of any codebase**: a repo-dependency graph + an interactive HTML dashboard, built from real code evidence — zero dependencies.
|
|
4
|
+
|
|
5
|
+
[](LICENSE)
|
|
6
|
+

|
|
7
|
+

|
|
8
|
+
[](https://github.com/HarperZ9/index-graph/actions/workflows/ci.yml)
|
|
9
|
+

|
|
10
|
+
|
|
11
|
+
`index` scans a workspace for Git repositories and renders a **dependency and topology graph** of them — as an interactive self-contained HTML dashboard, layered SVG, Mermaid, and a JSON context manifest. Every edge in the graph carries its own evidence (the file and line that witnesses it, plus a confidence grade). Output is deterministic; nothing to install beyond Python.
|
|
12
|
+
|
|
13
|
+
## 30-second quickstart
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pip install index-graph
|
|
17
|
+
index viz --root /path/to/your/workspace --format html --out graph.html
|
|
18
|
+
open graph.html # or: start graph.html on Windows
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
That produces a self-contained HTML file with an interactive dashboard: clickable nodes, layered layout, dependency lanes, and summary charts — no server, no assets, nothing to host.
|
|
22
|
+
|
|
23
|
+
To also write the raw JSON manifest:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
index map --root /path/to/your/workspace --output INDEX.json
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## What you get
|
|
30
|
+
|
|
31
|
+
| Output | Command | Description |
|
|
32
|
+
|--------|---------|-------------|
|
|
33
|
+
| **Interactive HTML dashboard** | `index viz --format html` | Self-contained; click nodes, explore layers and charts |
|
|
34
|
+
| **Layered SVG** | `index viz --format svg` | Static vector graph suitable for docs/CI artifacts |
|
|
35
|
+
| **Mermaid diagram** | `index viz --format mermaid` | Paste into GitHub markdown or any Mermaid renderer |
|
|
36
|
+
| **All three at once** | `index viz --format all --out-dir ./out` | Writes `graph.html`, `graph.svg`, `graph.mmd` |
|
|
37
|
+
| **JSON context manifest** | `index map` | Machine-readable inventory: remotes, branches, dirty counts, classification |
|
|
38
|
+
| **Dependency graph (text/JSON)** | `index graph` | Repo→repo edges with evidence; each edge carries its witness |
|
|
39
|
+
| **Context pack (prose + relations)** | `index context` | Synthesis pack: roles, relations, narrative summary |
|
|
40
|
+
|
|
41
|
+
## CLI reference
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
index map [--root ROOT] [--output FILE] [--json] [--config CFG]
|
|
45
|
+
index graph [--root ROOT] [--json]
|
|
46
|
+
index context [--root ROOT] [--focus REPO]
|
|
47
|
+
index viz [--root ROOT] [--format {html,svg,mermaid,all}]
|
|
48
|
+
[--focus REPO] [--no-external] [--out FILE] [--out-dir DIR]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
`--focus REPO` narrows any render to a single repo's bidirectional dependency neighborhood.
|
|
52
|
+
`--no-external` hides stdlib/third-party nodes, keeping the graph to workspace repos only.
|
|
53
|
+
|
|
54
|
+
## Dependency graph example
|
|
55
|
+
|
|
56
|
+
Running `index viz --root ./my-workspace --format mermaid` produces a Mermaid flowchart where
|
|
57
|
+
workspace repos are rectangular nodes and external dependencies are rounded nodes:
|
|
58
|
+
|
|
59
|
+
```mermaid
|
|
60
|
+
flowchart TD
|
|
61
|
+
n_api["api"]
|
|
62
|
+
n_core["core"]
|
|
63
|
+
n_cli["cli"]
|
|
64
|
+
n_pathlib(("pathlib"))
|
|
65
|
+
n_requests(("requests"))
|
|
66
|
+
n_core --> n_pathlib
|
|
67
|
+
n_api --> n_core
|
|
68
|
+
n_cli --> n_api
|
|
69
|
+
n_cli --> n_requests
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Every `-->` edge in the real output carries the file (and line) that witnesses it.
|
|
73
|
+
|
|
74
|
+
## Configuration
|
|
75
|
+
|
|
76
|
+
Place an optional `.index.toml` at your workspace root to control classification rules,
|
|
77
|
+
which remotes to drop, and parallel worker count:
|
|
78
|
+
|
|
79
|
+
```toml
|
|
80
|
+
# .index.toml — at your workspace root
|
|
81
|
+
[[rule]] # classify repos by workspace-relative path; first match wins
|
|
82
|
+
pattern = "oss/**"
|
|
83
|
+
class = "public"
|
|
84
|
+
|
|
85
|
+
[[rule]]
|
|
86
|
+
pattern = "work/**"
|
|
87
|
+
class = "internal"
|
|
88
|
+
|
|
89
|
+
[scan]
|
|
90
|
+
jobs = 16 # parallel workers
|
|
91
|
+
prune = ["vendor", "target"] # extra dirs to skip (added to the built-in safety set)
|
|
92
|
+
|
|
93
|
+
[privacy]
|
|
94
|
+
omit_origin_classes = ["internal"] # drop remote URLs for repos in these classes
|
|
95
|
+
|
|
96
|
+
[output]
|
|
97
|
+
portable = true # root-relative paths + hashed root (default on)
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
See [`example.index.toml`](example.index.toml) for the full schema and [`USAGE.md`](USAGE.md) for the
|
|
101
|
+
complete flag reference, the importable Python API, and worked examples with expected output.
|
|
102
|
+
|
|
103
|
+
## Guarantees
|
|
104
|
+
|
|
105
|
+
- **Evidence on every edge.** No edge appears in the graph without a file (and line) that witnesses it and a confidence grade (`high` when both a declared dependency and an observed import agree).
|
|
106
|
+
- **Deterministic output.** The same workspace produces the same JSON and renders every time.
|
|
107
|
+
- **Zero runtime dependencies.** Pure Python stdlib; nothing to install beyond Python 3.11+.
|
|
108
|
+
- **Portable maps.** Repository paths are root-relative; the local root is represented by a short hash; credential-shaped strings in remote URLs are always redacted.
|
|
109
|
+
|
|
110
|
+
## Install
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
pip install index-graph
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
Or from a checkout:
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
pip install -e .
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
**Zain Dana Harper** — small tools with explicit edges.
|
|
124
|
+
[Portfolio](https://harperz9.github.io) · [HarperZ9](https://github.com/HarperZ9)
|
|
125
|
+
<sub>Built with Claude Code; reviewed, tested, and owned by me.</sub>
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Release Checklist
|
|
2
|
+
|
|
3
|
+
## 0.1.0 Candidate
|
|
4
|
+
|
|
5
|
+
- [ ] Confirm `README.md`, `LICENSE`, `AUTHORS.md`, `CONTRIBUTING.md`, and
|
|
6
|
+
`CHANGELOG.md` are present.
|
|
7
|
+
- [ ] Run `python -m pytest -q`.
|
|
8
|
+
- [ ] Run `python -m build`.
|
|
9
|
+
- [ ] Run `python -m twine check dist/*`.
|
|
10
|
+
- [ ] Run `public-surface-sweeper . --summary`.
|
|
11
|
+
- [ ] Create a signed `v0.1.0` tag when signing is configured, or an
|
|
12
|
+
annotated `v0.1.0` tag when it is not.
|
|
13
|
+
- [ ] Publish to PyPI only after account ownership, 2FA, and trusted publishing
|
|
14
|
+
configuration are confirmed.
|
|
15
|
+
|
|
16
|
+
This repository does not auto-publish to a package registry.
|