deriva-cli 0.0.1__tar.gz → 0.8.0__tar.gz

deriva_cli-0.8.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: deriva-cli
+Version: 0.8.0
+Summary: Deriva is a research project aimed at enabling digital architects by automating the derivation of enterprise architecture models. Deriva uses dual knowledge graphs, heuristics and LLM's.
+Keywords: archimate,enterprise-architecture,code-analysis,llm,grafeo,fastapi
+Author: S. T. Grond
+Author-email: S. T. Grond <steven@deriva.dev>
+License-Expression: AGPL-3.0-or-later
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Typing :: Typed
+Requires-Dist: pydantic>=2
+Requires-Dist: pydantic-settings>=2
+Requires-Dist: python-dotenv>=1.2
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=15
+Requires-Dist: lxml>=6
+Requires-Dist: duckdb>=1.5
+Requires-Dist: grafeo>=0.6.0b1
+Requires-Dist: sqlglot>=30
+Requires-Dist: tree-sitter>=0.26
+Requires-Dist: tree-sitter-python>=0.23.0
+Requires-Dist: tree-sitter-javascript>=0.23.0
+Requires-Dist: tree-sitter-java>=0.23.0
+Requires-Dist: tree-sitter-c-sharp>=0.23
+Requires-Dist: pypdf>=6
+Requires-Dist: python-docx>=1.2
+Requires-Dist: spacy==3.8.16
+Requires-Dist: ctranslate2==4.8.2
+Requires-Dist: sentencepiece==0.2.2
+Requires-Dist: solvor>=0.6.3
+Requires-Dist: backoff>=2.2.1
+Requires-Dist: pydantic-ai>=2.55
+Requires-Dist: authlib>=1.8.0
+Requires-Dist: pyasn1>=0.6.4
+Requires-Dist: pyjwt>=2.15
+Requires-Dist: diskcache>=5.6.3
+Requires-Dist: nest-asyncio>=1.6.0
+Requires-Dist: structlog>=26.1.0
+Requires-Dist: typer>=0.27
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic-ai-slim[mistral]>=2.55
+Requires-Python: >=3.14
+Project-URL: Homepage, https://deriva.dev
+Project-URL: Documentation, https://docs.deriva.dev
+Project-URL: Repository, https://github.com/StevenBtw/deriva
+Project-URL: Issues, https://github.com/StevenBtw/deriva/issues
+Project-URL: Changelog, https://github.com/StevenBtw/deriva/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# Deriva CLI
+
+**From code repositories to ArchiMate models, from the command line.**
+
+Deriva reads a software repository, builds a graph of what is in it, and derives an [ArchiMate](https://www.opengroup.org/archimate-forum) enterprise architecture model you can open in [Archi](https://www.archimatetool.com/). `deriva-cli` runs the whole pipeline without a browser, for scripts, CI jobs and servers.
+
+```bash
+uv tool install --python 3.14 deriva-cli
+
+deriva-cli repo clone https://github.com/user/my-repo.git
+deriva-cli run all --repo my-repo -v
+deriva-cli export -o model.xml --repo my-repo
+deriva-cli status
+```
+
+- Configuration from the command line: `deriva-cli config list derivation`, `deriva-cli config show extraction BusinessConcept`; every change is a new version, earlier versions stay.
+- Models are configured in `.env` in the home folder `~/.deriva` (`DERIVA_HOME` moves it).
+- For the local web interface install [deriva-studio](https://pypi.org/project/deriva-studio/); for benchmarking, [deriva-dev](https://pypi.org/project/deriva-dev/).
+- Install it as a tool or in its own environment: its Python package is named `deriva`, like ISI's `deriva-py`, and the two cannot share an environment.
+
+Documentation: https://docs.deriva.dev. Source and releases: https://github.com/StevenBtw/deriva
+
+Deriva is part of a research project on AI-assisted domain modeling. License: AGPL-3.0-or-later.

deriva_cli-0.8.0/deriva/adapters/archimate/README.md

@@ -0,0 +1,98 @@
+# ArchiMate Adapter
+
+Create, validate, and export ArchiMate enterprise architecture models using grafeo (embedded).
+
+**Version:** 2.0.0
+
+## Purpose
+
+The ArchiMate adapter stores derived ArchiMate elements and relationships in grafeo (namespace: `Model`), validates them against the ArchiMate 3.2 metamodel, and exports to XML format compatible with the [Archi](https://www.archimatetool.com/) modeling tool.
+
+## Key Exports
+
+```python
+from deriva.adapters.archimate import (
+    ArchimateManager,      # Main service class
+    Element,               # ArchiMate element dataclass
+    Relationship,          # ArchiMate relationship dataclass
+    ArchiMateMetamodel,    # Metamodel validation rules
+    ArchiMateValidator,    # Validation logic
+    ArchiMateXMLExporter,  # XML export
+    ValidationError,       # Validation exception
+)
+```
+
+## Basic Usage
+
+```python
+from deriva.adapters.archimate import ArchimateManager, Element, Relationship
+
+with ArchimateManager() as am:
+    # Create elements
+    component = Element(
+        name="Authentication Module",
+        element_type="ApplicationComponent",
+        documentation="Handles user authentication"
+    )
+    am.add_element(component)
+
+    # Create relationships
+    rel = Relationship(
+        source=component.identifier,
+        target=other.identifier,
+        relationship_type="Serving"
+    )
+    am.add_relationship(rel)
+
+    # Query elements
+    elements = am.get_elements(element_type="ApplicationComponent")
+
+    # Export to Archi-compatible XML
+    am.export_to_xml("model.xml", model_name="My Model")
+```
+
+## File Structure
+
+```text
+deriva/adapters/archimate/
+├── __init__.py           # Package exports
+├── manager.py            # ArchimateManager class
+├── models.py             # Element, Relationship, ArchiMateMetamodel
+├── validation.py         # ArchiMateValidator, ValidationError
+└── xml_export.py         # ArchiMateXMLExporter
+```
+
+## Supported Types
+
+**Element Types** (ArchiMate 3.2):
+
+- Application Layer: `ApplicationComponent`, `ApplicationInterface`, `ApplicationService`, `DataObject`
+- Business Layer: `BusinessObject`, `BusinessProcess`, `BusinessFunction`, `BusinessActor`
+- Technology Layer: `Node`, `Device`, `SystemSoftware`, `TechnologyService`
+
+**Relationship Types**:
+
+- `Composition`, `Aggregation`, `Assignment`, `Realization`
+- `Serving`, `Access`, `Flow`
+
+## ArchimateManager Methods
+
+| Method | Description |
+|--------|-------------|
+| `add_element(element)` | Add an ArchiMate element |
+| `add_relationship(rel)` | Add a relationship between elements |
+| `get_element(identifier)` | Get element by ID |
+| `get_elements(element_type=None)` | Get all elements (optionally filtered) |
+| `get_relationships(source_id=None)` | Get relationships |
+| `clear_model()` | Clear all ArchiMate data |
+| `export_to_xml(path, model_name)` | Export to Archi XML format |
+| `query(cypher, params)` | Execute custom Cypher query |
+
+## Data Isolation
+
+Uses grafeo with namespace `Model` for label prefixing (e.g., `Model:ApplicationComponent`), keeping ArchiMate data separate from the Graph namespace.
+
+## See Also
+
+- [CONTRIBUTING.md](../../../CONTRIBUTING.md) - Architecture and coding guidelines
+- [Archi Tool](https://www.archimatetool.com/) - Open source ArchiMate modeling tool

deriva_cli-0.8.0/deriva/adapters/archimate/__init__.py

@@ -0,0 +1,48 @@
+"""ArchiMate Manager - Create, validate, and export ArchiMate models using Memgraph.
+
+This package provides comprehensive ArchiMate modeling capabilities:
+- Create and manage ArchiMate elements and relationships
+- Validate models against ArchiMate metamodel
+- Store models in Memgraph graph database
+- Export to ArchiMate XML format (compatible with Archi tool)
+
+Example:
+    >>> from archimate_manager import ArchimateManager, Element, Relationship
+    >>>
+    >>> with ArchimateManager() as am:
+    ...     # Create elements
+    ...     e1 = Element("Auth Module", "ApplicationComponent")
+    ...     e2 = Element("API Module", "ApplicationComponent")
+    ...     am.add_element(e1)
+    ...     am.add_element(e2)
+    ...
+    ...     # Create relationship
+    ...     rel = Relationship(e1.identifier, e2.identifier, "Composition")
+    ...     am.add_relationship(rel)
+    ...
+    ...     # Export to XML
+    ...     from archimate_manager.xml_export import ArchiMateXMLExporter
+    ...     exporter = ArchiMateXMLExporter()
+    ...     elements = am.get_elements()
+    ...     relationships = am.get_relationships()
+    ...     exporter.export(elements, relationships, "model.xml")
+"""
+
+from __future__ import annotations
+
+from .manager import ArchimateManager
+from .models import ArchiMateMetamodel, Element, Relationship
+from .validation import ArchiMateValidator, ValidationError
+from .xml_export import ArchiMateXMLExporter
+
+__all__ = [
+    "Element",
+    "Relationship",
+    "ArchimateManager",
+    "ArchiMateMetamodel",
+    "ArchiMateValidator",
+    "ValidationError",
+    "ArchiMateXMLExporter",
+]
+
+__version__ = "2.0.0"