impact-core 1.0.0__tar.gz

impact_core-1.0.0/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.

impact_core-1.0.0/MANIFEST.in

@@ -0,0 +1,18 @@
+# MANIFEST.in
+# Controls which non-Python files are included in the source distribution (sdist).
+
+# Documentation and metadata
+include README.md
+include LICENSE
+include requirements.txt
+include pyproject.toml
+
+# JSON schema files
+recursive-include core/schema *.json
+
+# Kubernetes deployment manifests
+recursive-include k8s *.yaml *.example
+
+# Test datasets (small, deterministic fixtures — not the large benchmark cache)
+recursive-include test_projects *.json *.java
+prune test_projects/github_benchmarks

impact_core-1.0.0/PKG-INFO

@@ -0,0 +1,366 @@
+Metadata-Version: 2.4
+Name: impact-core
+Version: 1.0.0
+Summary: Intent-based Multi-agent Platform for Architectural Change Tracking
+Author: IMPACT Project
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/IMPACT-Project/IMPACT
+Project-URL: Bug Tracker, https://github.com/IMPACT-Project/IMPACT/issues
+Keywords: software-architecture,dependency-graph,multi-agent,ast-parser,intent-based,software-evolution
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: networkx>=2.5
+Provides-Extra: java
+Requires-Dist: javalang>=0.13.0; extra == "java"
+Provides-Extra: shacl
+Requires-Dist: pyshacl>=0.20.0; extra == "shacl"
+Requires-Dist: rdflib>=6.0.0; extra == "shacl"
+Provides-Extra: crawler
+Requires-Dist: javalang>=0.13.0; extra == "crawler"
+Requires-Dist: pyshacl>=0.20.0; extra == "crawler"
+Requires-Dist: rdflib>=6.0.0; extra == "crawler"
+Provides-Extra: crawler-distributed
+Requires-Dist: impact-core[crawler]; extra == "crawler-distributed"
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "crawler-distributed"
+Provides-Extra: all
+Requires-Dist: impact-core[crawler-distributed,java,shacl]; extra == "all"
+Provides-Extra: dev
+Requires-Dist: impact-core[all]; extra == "dev"
+Requires-Dist: build>=0.10; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# IMPACT: Intent-based Multi-agent Platform for Architectural Change Tracking
+
+IMPACT is a language-agnostic multi-agent framework designed to monitor and manage the structural evolution of software systems. Drawing inspiration from Intent-Based Networking (IBN) in autonomic computing, IMPACT enables human software architects to specify high-level structural intents, such as preventing cyclic dependencies or limiting complexity growth. A swarm of cooperative agents then evaluates codebase transitions, detects violations, and provides explainable, natural-language refactoring advice.
+
+This project is built to align with the paradigm of Human-AI Collaboration, establishing a structured feedback loop where human expertise guides agentic analysis and governance.
+
+## Repository Structure
+
+The repository is organized as follows:
+
+*   **`core/`**: The core Python package of the IMPACT framework:
+    *   `schema/`: Standardized JSON schema for software dependency graphs.
+    *   `agents/`: Specialized agent implementations including the Coordinator, Graph, Diff, Metrics, and LLM agents.
+    *   `graph_utils.py`: Utility functions for loading graphs and computing structural diffs.
+*   **`adapters/`**: Pluggable source code extraction layers:
+    *   `java/`: Python-based parser that walks Java project directories, extracts FQCNs, resolves dependency call-graphs, and exports JSON graphs.
+*   **`test_projects/`**: Datasets and source folders simulating software evolution:
+    *   `telemetry_service_v1/`: Version 1.0.0 Java source code of TelemetryService.
+    *   `telemetry_service_v2/`: Version 2.0.0 Java source code of TelemetryService.
+    *   `v1_graph.json`: Extracted dependency graph for Version 1.0.0.
+    *   `v2_graph.json`: Extracted dependency graph for Version 2.0.0.
+*   **`run_demo.py`**: Execution script to run the multi-agent evolution tracker.
+*   **`test_impact.py`**: Automated unit test suite to verify graph loading, diff calculations, and coordinator orchestration.
+
+## Installation & Setup
+
+IMPACT targets Python 3.8 or higher. The package (`impact-core`) will be published to PyPI — for now, install from source.
+
+> **PyPI status:** automated publishing is configured via GitHub Actions (see `.github/workflows/publish.yml`) and will trigger on the first version tag push. Until then, use the source install below.
+
+### Install from source (recommended while in active development)
+
+```bash
+git clone https://github.com/IMPACT-Project/IMPACT.git
+cd IMPACT
+pip install -e ".[dev]"   # editable install with all deps + build/test tools
+```
+
+Or install only what you need:
+
+```bash
+pip install -e .                        # core only
+pip install -e ".[java]"               # + Java AST extractor
+pip install -e ".[crawler]"            # + full crawler stack (SQLite)
+pip install -e ".[crawler-distributed]" # + PostgreSQL distributed crawler
+pip install -e ".[all]"               # everything
+```
+
+### Install from PyPI (once published)
+
+```bash
+# Core only — graph loading, diff, coordinator, SHACL validator
+pip install impact-core
+
+# + Java AST extractor (recommended for local extraction)
+pip install impact-core[java]
+
+# + Full crawler stack (javalang, pyshacl, rdflib) — single-node SQLite
+pip install impact-core[crawler]
+
+# + Distributed crawler (PostgreSQL backend)
+pip install impact-core[crawler-distributed]
+
+# Everything
+pip install impact-core[all]
+```
+
+### Releasing a new version to PyPI
+
+```bash
+git tag v1.x.y && git push origin v1.x.y   # GitHub Actions does the rest
+```
+
+See [DEPLOY.md](DEPLOY.md) for the full release workflow, one-time PyPI Trusted
+Publisher setup, Docker, and Kubernetes deployment instructions.
+
+### Console scripts
+
+After installation the following commands are available on your `PATH`:
+
+| Command | Description |
+|---------|-------------|
+| `impact-crawl` | GitHub ecosystem crawler CLI |
+| `impact-extract` | Java AST dependency graph extractor |
+| `impact-demo` | Run the built-in TelemetryService evolution demo |
+| `impact-dashboard` | Launch the interactive architect dashboard |
+
+
+## Running the Project
+
+### Running Graph Extraction (Java Adapter)
+
+```bash
+# Via installed console script (after pip install impact-core[java])
+impact-extract <projectName> <version> <srcDirectory> <outputJsonPath>
+
+# Or directly
+python3 adapters/java/extractor.py <projectName> <version> <srcDirectory> <outputJsonPath>
+```
+
+For example, to extract graphs for the mock `TelemetryService` project:
+
+```bash
+impact-extract TelemetryService 1.0.0 test_projects/telemetry_service_v1/src test_projects/v1_graph.json
+impact-extract TelemetryService 2.0.0 test_projects/telemetry_service_v2/src test_projects/v2_graph.json
+```
+
+### Running the Demo
+
+```bash
+# Via installed console script
+impact-demo
+
+# Or directly
+python3 run_demo.py
+```
+
+This runs the Coordinator agent, orchestrates the swarm, evaluates intents against the graph diffs, and generates the compliance report.
+
+### Running the Architect Dashboard (UI)
+
+```bash
+# Via installed console script
+impact-dashboard
+
+# Or directly
+python3 run_dashboard.py
+```
+
+This starts a local development server and automatically opens the dashboard interface at `http://localhost:8080/dashboard/index.html`. In the dashboard, you can visually explore the dependency graphs (with cycles highlighted in red), add new intents, trigger evolution analyses, and view tabular diff metrics.
+
+![IMPACT Architect Dashboard UI](docs/dashboard_screenshot.png)
+
+
+### Running Unit Tests
+
+```bash
+python3 -m unittest discover -p "test_*.py"
+```
+
+
+### Running the Model Context Protocol (MCP) Server
+
+To run the stdio-compliant Model Context Protocol server:
+
+```bash
+python3 -m core.mcp_server
+```
+
+This starts the server on stdio. Any MCP-compatible client (such as Claude Desktop) can connect to it and invoke the `run_evolution_analysis` and `extract_java_graph` tools.
+
+### Running PMD Static Analysis Merger
+
+To integrate PMD static analysis reports into the extracted dependency graph, run:
+
+```bash
+python3 adapters/java/static_analyzer.py <graphJsonPath> <pmdJsonPath>
+```
+
+For example, to merge our mock PMD report into the Version 2 graph:
+
+```bash
+python3 adapters/java/static_analyzer.py test_projects/v2_graph.json test_projects/pmd_report_v2.json
+```
+
+### Running the SHACL Structural Validator
+
+To validate your JSON-LD software graphs against our SHACL structural shapes, execute:
+
+```bash
+python3 core/shacl_validator.py <graphJsonPath>
+```
+
+
+
+## How It Works
+
+1.  **Codebase Extraction**: Pluggable language adapters parse a codebase and export its structural dependency network and metrics conforming to the standardized JSON schema.
+2.  **Orchestration**: The Coordinator agent manages the evaluation loop.
+3.  **Graph Analysis**: The Graph agent loads the JSON-LD files, and the Metrics agent calculates network centralities to identify coupling hubs.
+4.  **Version Comparison**: The Diff agent compares adjacent versions to discover added, removed, or modified nodes and edges, as well as newly introduced cycles.
+5.  **Intent Conformance**: The LLM agent evaluates the diff metrics against the user-specified architectural intents, outputting a compliance report and refactoring recommendations.
+
+---
+
+## Distributed Ecosystem Crawler
+
+IMPACT ships a GitHub ecosystem crawler that discovers, downloads, and analyses large numbers of open-source Java projects at scale. It can run as a single local process (backed by SQLite) or as a distributed multi-node cluster (backed by PostgreSQL).
+
+### Running Locally (SQLite, single process)
+
+```bash
+# 1. Populate the queue with the most-starred Java repositories
+python3 -m core.ecosystem_crawler discover --min-stars 1000
+
+# 2. Process queued repositories
+python3 -m core.ecosystem_crawler crawl --limit 50
+
+# 3. Check queue status and recent transitions
+python3 -m core.ecosystem_crawler status
+```
+
+---
+
+### Running with Docker (single node)
+
+Build the crawler image:
+
+```bash
+docker build -t impact-crawler:latest .
+```
+
+Run discovery then crawl with a local SQLite database:
+
+```bash
+docker run --rm \
+  -v "$(pwd)/test_projects:/app/test_projects" \
+  impact-crawler:latest discover --min-stars 1000
+
+docker run --rm \
+  -v "$(pwd)/test_projects:/app/test_projects" \
+  impact-crawler:latest crawl --limit 50
+```
+
+To use a GitHub token (recommended to avoid rate limits):
+
+```bash
+docker run --rm \
+  -e GITHUB_TOKEN=ghp_yourtoken \
+  -v "$(pwd)/test_projects:/app/test_projects" \
+  impact-crawler:latest discover --min-stars 1000
+```
+
+---
+
+### Running on Kubernetes (multi-node distributed)
+
+The `k8s/` directory contains all Kubernetes manifests. Multiple crawler worker pods coordinate on a shared PostgreSQL queue using `SELECT FOR UPDATE SKIP LOCKED` — each pod atomically claims a repository and no two pods process the same one.
+
+#### Prerequisites
+
+- A running Kubernetes cluster (local: [minikube](https://minikube.sigs.k8s.io/) or [kind](https://kind.sigs.k8s.io/))
+- `kubectl` configured to point at it
+- The `impact-crawler:latest` image built and available in the cluster
+
+#### Step 1 — Create the namespace
+
+```bash
+kubectl apply -f k8s/namespace.yaml
+```
+
+#### Step 2 — Create the database secret (not committed to git)
+
+```bash
+# Option A: imperative (nothing touches disk — recommended)
+kubectl create secret generic postgres-secret \
+  --from-literal=username=impact \
+  --from-literal=password=yourpassword \
+  -n impact-crawler
+
+# Option B: file-based (stays local, already gitignored)
+cp k8s/secret.yaml.example k8s/secret.yaml
+# Edit k8s/secret.yaml — replace REPLACE_WITH_BASE64_* with real values:
+#   echo -n 'impact' | base64
+#   echo -n 'yourpassword' | base64
+kubectl apply -f k8s/secret.yaml
+```
+
+> **Security note:** `k8s/secret.yaml` is listed in `.gitignore` and must never be committed.
+> Only `k8s/secret.yaml.example` (with placeholder values) is tracked in git.
+
+#### Step 3 — Deploy PostgreSQL and configuration
+
+```bash
+kubectl apply -f k8s/configmap.yaml
+kubectl apply -f k8s/postgres.yaml
+
+# Wait for PostgreSQL to be ready
+kubectl wait --for=condition=ready pod -l app=postgres \
+  -n impact-crawler --timeout=60s
+```
+
+#### Step 4 — Run the discovery Job (populates the queue)
+
+```bash
+kubectl apply -f k8s/discovery-job.yaml
+kubectl wait --for=condition=complete job/crawler-discovery \
+  -n impact-crawler --timeout=300s
+```
+
+#### Step 5 — Start the distributed crawler workers
+
+```bash
+kubectl apply -f k8s/crawler-deployment.yaml
+```
+
+This starts **4 parallel worker pods** by default. Watch them drain the queue:
+
+```bash
+kubectl logs -l role=worker -n impact-crawler --follow
+```
+
+#### Scaling workers up or down
+
+```bash
+kubectl scale deployment crawler-worker --replicas=8 -n impact-crawler
+```
+
+#### Applying everything at once (after the secret exists)
+
+```bash
+kubectl apply -k k8s/
+```
+
+#### Removing the deployment
+
+```bash
+kubectl delete namespace impact-crawler
+```
+