graphkeeper-cli 0.1.0__tar.gz

graphkeeper_cli-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+.venv-freshinstall/
+dist/
+build/
+*.egg-info/
+__pycache__/
+*.pyc
+.pytest_cache/

graphkeeper_cli-0.1.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 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
+
+   Copyright 2026 Rudrendu Paul
+
+   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.

graphkeeper_cli-0.1.0/PKG-INFO

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: graphkeeper-cli
+Version: 0.1.0
+Summary: Local-first CLI that mines git history for file-level co-change patterns and builds a queryable knowledge graph for AI coding agents, with optional enrichment from graphify's symbol/call-graph output when it is installed.
+Project-URL: Homepage, https://github.com/RudrenduPaul/GraphKeeper
+Project-URL: Repository, https://github.com/RudrenduPaul/GraphKeeper
+Project-URL: Bug Tracker, https://github.com/RudrenduPaul/GraphKeeper/issues
+Project-URL: Changelog, https://github.com/RudrenduPaul/GraphKeeper/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/RudrenduPaul/GraphKeeper/blob/main/docs/getting-started.md
+Project-URL: Author - Rudrendu Paul, https://github.com/RudrenduPaul
+Project-URL: Author - Sourav Nandy, https://github.com/Sourav-nandy-ai
+Author: Rudrendu Paul, Sourav Nandy
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent-native,ai-agent,cli,co-change,code-intelligence,developer-tools,git,graphify,knowledge-graph,local-first
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.0; extra == 'dev'
+Requires-Dist: pytest<9,>=7.0; extra == 'dev'
+Requires-Dist: twine<7,>=5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# graphkeeper-cli (Python)
+
+A local-only CLI and library that mines your `git log` for which files
+actually change together, then hands an AI coding agent a queryable answer
+instead of a grep across the whole history.
+
+[![PyPI version](https://img.shields.io/pypi/v/graphkeeper-cli.svg)](https://pypi.org/project/graphkeeper-cli/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/RudrenduPaul/GraphKeeper/blob/main/LICENSE)
+[![Python versions](https://img.shields.io/pypi/pyversions/graphkeeper-cli.svg)](https://pypi.org/project/graphkeeper-cli/)
+[![npm version](https://img.shields.io/npm/v/graphkeeper-cli.svg)](https://www.npmjs.com/package/graphkeeper-cli)
+
+## Why this exists
+
+An AI coding agent working solo on a codebase it doesn't fully know yet
+usually has no fast way to answer "what else changes when I touch this
+file?" short of scrolling `git log -p` or grepping blindly. GraphKeeper
+mines the commit history that's already sitting on disk and turns it into
+one queryable, local answer -- no server, no account, no embeddings API,
+nothing leaves the machine. This package is the Python distribution -- a
+genuine, independent port of the npm package's TypeScript source, not a
+wrapper around the Node binary. It has zero third-party runtime
+dependencies: only the Python standard library (`subprocess`, `argparse`,
+`json`) and the real `git` binary on `PATH`.
+
+## Install
+
+```bash
+pip install graphkeeper-cli
+```
+
+or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add graphkeeper-cli
+```
+
+Requires Python 3.9+ and `git` on your `PATH`. The complementary JS/TS
+distribution installs the same way on the npm side: `npm install -g
+graphkeeper-cli` (or `npx graphkeeper-cli build` to run it once without
+installing) -- see the
+[project README](https://github.com/RudrenduPaul/GraphKeeper#readme) for
+that package. Both are first-class and maintained together; neither is
+deprecated in favor of the other. As of this writing the npm package's own
+publish to the npm registry has not yet been attempted (a separate,
+unstarted task), but its source and this Python port are both complete and
+kept in parity.
+
+## Quickstart
+
+Clone the repo and index it (works against any git repo, including this
+one):
+
+```bash
+git clone https://github.com/RudrenduPaul/GraphKeeper.git
+cd GraphKeeper/python
+pip install -e .
+graphkeeper build ..
+```
+
+```
+GraphKeeper build complete: /path/to/GraphKeeper
+
+Co-change graph: 6 commit(s) analyzed, 80 file pair(s) found
+graphify enrichment: skipped -- graphify was not found on PATH. Install it with
+`uv tool install graphifyy` (or `pipx install graphifyy`) for symbol/call-graph
+enrichment; GraphKeeper works fine without it, in co-change-only mode.
+
+Wrote /path/to/GraphKeeper/.graphkeeper/graph.json
+```
+
+(Real output from running this Python CLI against the GraphKeeper repo's
+own checkout, this early in its history -- co-change counts grow as the
+codebase accumulates more commits. Byte-for-byte the same command against
+the npm CLI, against the same checkout, produces the same numbers -- both
+distributions mine the same `git log`.)
+
+Now query it:
+
+```bash
+graphkeeper query co-change src/git.ts
+```
+
+```
+Files that historically change alongside "src/git.ts":
+
+     1  src/store.ts
+     1  src/types.ts
+     1  test/git.test.ts
+     1  test/store.test.ts
+     1  test/test-helpers.ts
+```
+
+If [graphify](https://github.com/Graphify-Labs/graphify) is installed
+(`uv tool install graphifyy`), `graphkeeper build` automatically shells out
+to its local, no-API-key `graphify extract --code-only` and merges its
+symbol/call-graph into the same store, unlocking call-graph queries.
+Without graphify installed, `graphkeeper query calls <symbol>` explains
+exactly why the answer isn't available instead of crashing or returning an
+empty result:
+
+```
+Call-graph query for "mineCoChange" is not available.
+
+graphify was not found on PATH. Install it with `uv tool install graphifyy`
+(or `pipx install graphifyy`) for symbol/call-graph enrichment; GraphKeeper
+works fine without it, in co-change-only mode.
+```
+
+Every command also supports `--json` for scripts and agents.
+
+## Using the library instead of the CLI
+
+```python
+from graphkeeper import build, query_co_change, BuildOptions
+
+result = build(".", BuildOptions(skip_graphify=True))
+print(f"{result.store.commits_analyzed} commit(s) analyzed")
+
+co_change = query_co_change(result.store, "src/git.ts", limit=5)
+for row in co_change.results:
+    print(row.count, row.file)
+```
+
+`graphkeeper.cli` is a thin `argparse` wrapper over these same functions,
+so anything scriptable from the command line is also usable directly from
+Python -- the agent-native path.
+
+## CLI reference
+
+```
+usage: graphkeeper [-h] [-V] {build,query} ...
+
+Commands:
+  build [options] [path]  Mine git history for co-change and (if available)
+                           merge in graphify's symbol/call graph
+  query co-change <file>  List files that historically change alongside
+                           <file>, ranked by co-change frequency
+  query calls <symbol>    Show callers/callees of <symbol> (requires
+                           graphify enrichment)
+```
+
+### `graphkeeper build [path]`
+
+Walks `path` (default: current directory), runs `git log --no-merges
+--name-only` across the whole history, and counts how often each pair of
+files was touched in the same commit. Writes the result to
+`.graphkeeper/graph.json`.
+
+| Option | Description |
+|---|---|
+| `--json` | emit machine-readable JSON instead of human-readable text |
+| `--max-files-per-commit <n>` | skip commits touching more than this many files (default: 100) -- keeps a single mass-reformat or vendoring commit from drowning out real co-change signal |
+| `--no-graphify` | skip graphify enrichment even if graphify is installed |
+
+### `graphkeeper query co-change <file>`
+
+Lists files that historically changed alongside `<file>`, ranked by how
+many commits touched both.
+
+| Option | Description |
+|---|---|
+| `--json` | emit machine-readable JSON instead of human-readable text |
+| `--limit <n>` | cap the number of results |
+| `--graph <path>` | path to a specific `graph.json` (default: `<cwd>/.graphkeeper/graph.json`) |
+
+Exit code `0` when results are found, `1` when there's no co-change data
+for that file yet, `2` on a usage or filesystem error.
+
+### `graphkeeper query calls <symbol>`
+
+Shows callers and callees of `<symbol>`, using graphify's `calls` edges
+from the most recent `build`. Only meaningful when that build included
+graphify enrichment -- if it didn't, this prints a clear explanation of why
+(never a crash, never a silent empty result).
+
+| Option | Description |
+|---|---|
+| `--json` | emit machine-readable JSON instead of human-readable text |
+| `--graph <path>` | path to a specific `graph.json` (default: `<cwd>/.graphkeeper/graph.json`) |
+
+Exit code `0` when the symbol is found, `1` when it isn't (or enrichment
+wasn't available), `2` on a usage or filesystem error.
+
+## How it works
+
+Same pipeline as the npm package (see the
+[project README](https://github.com/RudrenduPaul/GraphKeeper#how-it-works)
+for the full narrative): `git log --no-merges --name-only` mined via a safe
+argv-list subprocess call (never a shell string), pairs of co-changed files
+counted per commit (commits touching more than `--max-files-per-commit`
+files skipped), optionally merged with graphify's local symbol/call graph
+when graphify is on `PATH`, and written once, atomically, to
+`.graphkeeper/graph.json`. The on-disk JSON schema uses the same field
+names (`commitsAnalyzed`, `coChange`, `fileCommitCounts`, etc.) as the npm
+package's store, so a `.graphkeeper/graph.json` written by either
+distribution can be read back by the other.
+
+## Security
+
+- Every `git` and `graphify` invocation uses an argv list passed directly
+  to the OS (`subprocess.run`, `shell=False`), never a shell string, so
+  commit messages, file names, or repo paths can't be interpreted as shell
+  syntax.
+- `.graphkeeper/` output paths are checked against the resolved repo root
+  before every write (symlinks included), so a maliciously crafted repo
+  can't redirect GraphKeeper's writes outside `.graphkeeper/`.
+- No telemetry, no network calls, no secrets, zero third-party runtime
+  dependencies. The only files GraphKeeper reads are `git log` output and
+  (optionally) graphify's own `graph.json`; the only file it writes is
+  `.graphkeeper/graph.json`.
+- See [SECURITY.md](https://github.com/RudrenduPaul/GraphKeeper/blob/main/SECURITY.md)
+  for the private disclosure process.
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/RudrenduPaul/GraphKeeper/blob/main/CONTRIBUTING.md)
+for the full guide, covering both the TypeScript and Python codebases (they
+must stay in behavioral parity). To build from source:
+
+```bash
+cd python
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+Apache 2.0, see [LICENSE](https://github.com/RudrenduPaul/GraphKeeper/blob/main/LICENSE).