shellsmith 0.1.0__tar.gz → 0.2.1__tar.gz

{shellsmith-0.1.0/src/shellsmith.egg-info → shellsmith-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shellsmith
-Version: 0.1.0
+Version: 0.2.1
 Summary: A Python toolkit and CLI for managing Asset Administration Shells
 Author-email: Peter Stein <peterstein@dfki.de>
 License: MIT License
@@ -41,6 +41,8 @@ Requires-Dist: isort; extra == "test"
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-dotenv; extra == "test"
+Provides-Extra: neo4j
+Requires-Dist: neo4j; extra == "neo4j"
 Dynamic: license-file
 
 [![Python Package](https://github.com/ptrstn/shellsmith/actions/workflows/python-package.yaml/badge.svg)](https://github.com/ptrstn/shellsmith/actions/workflows/python-package.yaml)
@@ -92,8 +94,12 @@ Common commands:
 ```bash
 aas info                  # Show all shells and submodels
 aas upload <file|folder>  # Upload AAS file or folder
+
 aas shell delete <id>     # Delete a shell
 aas submodel delete <id>  # Delete a submodel
+
+aas sme get <id> <path>               # Get Submodel element value
+aas sme patch <id> <path> <new_value> # Set Submodel element value
 ```
 
 Use `--cascade` or `--unlink` to control deletion behavior:

{shellsmith-0.1.0 → shellsmith-0.2.1}/README.md

@@ -47,8 +47,12 @@ Common commands:
 ```bash
 aas info                  # Show all shells and submodels
 aas upload <file|folder>  # Upload AAS file or folder
+
 aas shell delete <id>     # Delete a shell
 aas submodel delete <id>  # Delete a submodel
+
+aas sme get <id> <path>               # Get Submodel element value
+aas sme patch <id> <path> <new_value> # Set Submodel element value
 ```
 
 Use `--cascade` or `--unlink` to control deletion behavior:

{shellsmith-0.1.0 → shellsmith-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "shellsmith"
-version = "0.1.0"
+version = "0.2.1"
 description = "A Python toolkit and CLI for managing Asset Administration Shells"
 authors = [{ name = "Peter Stein", email = "peterstein@dfki.de" }]
 license = { file = "LICENSE" }
@@ -29,6 +29,10 @@ test = [
     "pytest-dotenv",
 ]
 
+neo4j = [
+    "neo4j",
+]
+
 [project.scripts]
 aas = "shellsmith.cli.main:main"
 

{shellsmith-0.1.0 → shellsmith-0.2.1}/src/shellsmith/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.0"
+__version__ = "0.2.1"
 
 from .crud.shells import (  # noqa: F401
     delete_shell,

{shellsmith-0.1.0 → shellsmith-0.2.1}/src/shellsmith/cli/commands/__init__.py

@@ -2,4 +2,5 @@ from .info import info  # noqa: F401
 from .nuke import nuke  # noqa: F401
 from .shell import shell_delete  # noqa: F401
 from .submodel import submodel_delete  # noqa: F401
+from .sme import submodel_element_get, submodel_element_patch  # noqa: F401
 from .upload import upload  # noqa: F401

{shellsmith-0.1.0 → shellsmith-0.2.1}/src/shellsmith/cli/commands/info.py

@@ -17,21 +17,25 @@ def print_unreferenced_submodels():
         print("⚠️ Unreferenced Submodels:")
         for submodel_id in submodel_ids:
             submodel = shellsmith.get_submodel(submodel_id)
-            id_short = submodel["idShort"]
+            id_short = submodel.get("idShort", "<no idShort>")
             print(f"- {id_short} ({submodel_id})")
 
 
 def print_shells_tree():
     shells = shellsmith.get_shells()
     for shell in shells:
-        print(f"{shell['idShort']}: {shell['id']}")
+        shell_id = shell['id']
+        shell_id_short = shell.get('idShort', "<no idShort>")
+        print(f"{shell_id_short}: {shell_id}")
 
-        submodels = services.get_shell_submodels(shell["id"])
+        submodels = services.get_shell_submodels(shell_id)
 
         for i, submodel in enumerate(submodels):
             is_last = i == len(submodels) - 1
             prefix = "└──" if is_last else "├──"
-            print(f"{prefix} {submodel['idShort']}: {submodel['id']}")
+            submodel_id = submodel['id']
+            submodel_id_short = submodel.get('idShort', "<no idShort>")
+            print(f"{prefix} {submodel_id}: {submodel_id_short}")
 
 
 def print_dangling_submodel_refs():
@@ -42,6 +46,7 @@ def print_dangling_submodel_refs():
         print("⚠️ Dangling Submodel References:")
         for shell_id, submodel_ids in dangling.items():
             shell = shellsmith.get_shell(shell_id)
-            print(f"- {shell['idShort']}: {shell_id}")
+            shell_id_short = shell.get('idShort', "<no idShort>")
+            print(f"- {shell_id_short}: {shell_id}")
             for submodel_id in submodel_ids:
                 print(f"  └── {submodel_id}")

shellsmith-0.2.1/src/shellsmith/cli/commands/sme.py

@@ -0,0 +1,13 @@
+import shellsmith
+
+
+def submodel_element_get(submodel_id: str, id_short_path: str):
+    print(f"{submodel_id} -> {id_short_path}:")
+    element = shellsmith.get_submodel_element(submodel_id, id_short_path)
+    value = element.get("value")
+    print(value)
+
+
+def submodel_element_patch(submodel_id: str, id_short_path: str, value: str):
+    shellsmith.patch_submodel_element_value(submodel_id, id_short_path, value)
+    print(f"✅ Updated '{id_short_path}' in Submodel '{submodel_id}'")

{shellsmith-0.1.0 → shellsmith-0.2.1}/src/shellsmith/cli/main.py

@@ -3,20 +3,28 @@ import requests
 from shellsmith import __version__, services
 from shellsmith.config import config
 
-from .commands import info, nuke, shell_delete, submodel_delete, upload
+from .commands import (
+    info,
+    nuke,
+    shell_delete,
+    submodel_delete,
+    submodel_element_get,
+    submodel_element_patch,
+    upload,
+)
 from .parser import build_parser
+from ..utils import base64_decode, base64_encode
 
 
 def print_header():
     print("===============================================")
-    print(f"Shellsmith - AAS Toolkit v{__version__}")
-    print(f"Host: {config.host} ({services.health()})")
+    print(f" Shellsmith - AAS Toolkit v{__version__}")
+    print(f" Host: {config.host} ({services.health()})")
     print("===============================================")
     print()
 
 
 def main():
-    print_header()
     parser = build_parser()
     args = parser.parse_args()
 
@@ -26,6 +34,12 @@ def main():
         "nuke": lambda _args: nuke(),
         "shell.delete": lambda _args: shell_delete(args.id, cascade=args.cascade),
         "submodel.delete": lambda _args: submodel_delete(args.id, unlink=args.unlink),
+        "sme.get": lambda _args: submodel_element_get(args.id, args.path),
+        "sme.patch": lambda _args: submodel_element_patch(
+            args.id, args.path, args.value
+        ),
+        "encode": lambda _args: print(base64_encode(args.id)),
+        "decode": lambda _args: print(base64_decode(args.value)),
     }
 
     try:
@@ -34,9 +48,13 @@ def main():
             key += f".{args.shell_command}"
         elif key == "submodel" and args.submodel_command:
             key += f".{args.submodel_command}"
+        elif key == "sme" and args.submodel_element_command:
+            key += f".{args.submodel_element_command}"
 
         handler = commands.get(key)
         if handler:
+            if key not in ("encode", "decode"):
+                print_header()
             handler(args)
         else:
             parser.print_help()

{shellsmith-0.1.0 → shellsmith-0.2.1}/src/shellsmith/cli/parser.py

@@ -26,6 +26,7 @@ def build_parser():
     # ──────────────────────────── shell ─────────────────────────────
     shell_parser = subparsers.add_parser(
         "shell",
+        aliases=["sh"],
         help="Manage Asset Administration Shells",
     )
     shell_subparsers = shell_parser.add_subparsers(dest="shell_command")
@@ -42,7 +43,9 @@ def build_parser():
     )
 
     # ───────────────────────────── submodel ─────────────────────────────
-    submodel_parser = subparsers.add_parser("submodel", help="Manage Submodels")
+    submodel_parser = subparsers.add_parser(
+        "submodel", aliases=["sm"], help="Manage Submodels"
+    )
     submodel_subparsers = submodel_parser.add_subparsers(dest="submodel_command")
     submodel_delete_parser = submodel_subparsers.add_parser(
         "delete",
@@ -60,4 +63,35 @@ def build_parser():
         help="Remove all Shell references to this Submodel",
     )
 
+    # ───────────────────── submodel-element ─────────────────────
+    sme_parser = subparsers.add_parser(
+        "submodel-element",
+        aliases=["sme"],
+        help="Manage Submodel Elements",
+    )
+    sme_subparsers = sme_parser.add_subparsers(dest="submodel_element_command")
+
+    sme_get_parser = sme_subparsers.add_parser(
+        "get",
+        help="Get value of a Submodel Element",
+    )
+    sme_get_parser.add_argument("id", type=str, help="Submodel ID")
+    sme_get_parser.add_argument("path", type=str, help="idShort path")
+
+    sme_patch_parser = sme_subparsers.add_parser(
+        "patch",
+        help="Patch value of a Submodel Element",
+    )
+    sme_patch_parser.add_argument("id", type=str, help="Submodel ID")
+    sme_patch_parser.add_argument("path", type=str, help="idShort path")
+    sme_patch_parser.add_argument("value", type=str, help="New value")
+
+    # ───────────────────────────── encode ─────────────────────────────
+    encode_parser = subparsers.add_parser("encode", help="Encode a string to base64")
+    encode_parser.add_argument("id", type=str, help="Text to encode")
+
+    # ───────────────────────────── decode ─────────────────────────────
+    decode_parser = subparsers.add_parser("decode", help="Decode a base64 string")
+    decode_parser.add_argument("value", type=str, help="Base64 string to decode")
+
     return parser

{shellsmith-0.1.0 → shellsmith-0.2.1}/src/shellsmith/config.py

@@ -9,7 +9,11 @@ class Settings(BaseSettings):
     def host(self):
         return self.basyx_env_host
 
-    model_config = SettingsConfigDict(env_file=".env", env_prefix="SHELLSMITH_")
+    model_config = SettingsConfigDict(
+        env_file=".env",
+        env_prefix="SHELLSMITH_",
+        extra="ignore",
+    )
 
 
 config = Settings()

shellsmith-0.2.1/src/shellsmith/neo4j.py

@@ -0,0 +1,115 @@
+from typing import Any, Dict, List, Optional
+
+from neo4j import Driver, GraphDatabase
+
+from shellsmith.config import config
+
+_driver: Optional[Driver] = None
+
+
+def get_driver() -> Driver:
+    global _driver
+    if _driver is None:
+        _driver = GraphDatabase.driver(config.neo4j_uri, auth=None)
+    return _driver
+
+
+def close_driver():
+    global _driver
+    if _driver is not None:
+        _driver.close()
+        _driver = None
+
+
+##################
+# Shells
+##################
+
+
+def get_shells() -> List[Dict[str, Any]]:
+    query = """
+    MATCH (shell:AssetAdministrationShell)
+    RETURN shell;
+    """
+    with get_driver().session() as session:
+        result = session.run(query)
+        shells = [dict(record["shell"]) for record in result]
+        return shells
+
+
+def get_shell(shell_id: str) -> Optional[Dict[str, Any]]:
+    query = """
+    MATCH (shell:AssetAdministrationShell {id: $shell_id})
+    RETURN shell;
+    """
+    with get_driver().session() as session:
+        result = session.run(query, shell_id=shell_id)
+        record = result.single()
+        return dict(record["shell"]) if record else None
+
+
+##################
+# Submodels
+##################
+
+
+def get_submodels() -> List[Dict[str, Any]]:
+    query = """
+    MATCH (submodel:Submodel)
+    RETURN submodel
+    """
+    with get_driver().session() as session:
+        result = session.run(query)
+        submodels = [dict(record["submodel"]) for record in result]
+        return submodels
+
+
+def get_submodel(submodel_id: str) -> Dict[str, Any]:
+    query = """
+    MATCH (submodel:Submodel {id: $submodel_id})
+    RETURN submodel
+    """
+    with get_driver().session() as session:
+        result = session.run(query, submodel_id=submodel_id)
+        record = result.single()
+        return dict(record["submodel"]) if record else None
+
+
+def get_submodel_elements(submodel_id: str) -> List[Dict[str, Any]]:
+    query = """
+    MATCH (sme:SubmodelElement {smId: $submodel_id})
+    RETURN sme;
+    """
+    with get_driver().session() as session:
+        result = session.run(query, submodel_id=submodel_id)
+        return [dict(record["sme"]) for record in result]
+
+
+def get_submodel_element(
+    submodel_id: str, id_short_path: str
+) -> Optional[Dict[str, Any]]:
+    query = """
+    MATCH (sme:SubmodelElement {smId: $submodel_id, idShortPath: $id_short_path})
+    RETURN sme;
+    """
+    with get_driver().session() as session:
+        result = session.run(
+            query,
+            submodel_id=submodel_id,
+            id_short_path=id_short_path,
+        )
+        record = result.single()
+        return dict(record["sme"]) if record else None
+
+
+def detach_delete_all():
+    """
+    Dangerous!
+    Deletes all nodes and relationships in the graph.
+    """
+    query = """
+    MATCH (n)
+    DETACH DELETE n;
+    """
+    with get_driver().session() as session:
+        session.run(query)

{shellsmith-0.1.0 → shellsmith-0.2.1/src/shellsmith.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shellsmith
-Version: 0.1.0
+Version: 0.2.1
 Summary: A Python toolkit and CLI for managing Asset Administration Shells
 Author-email: Peter Stein <peterstein@dfki.de>
 License: MIT License
@@ -41,6 +41,8 @@ Requires-Dist: isort; extra == "test"
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-dotenv; extra == "test"
+Provides-Extra: neo4j
+Requires-Dist: neo4j; extra == "neo4j"
 Dynamic: license-file
 
 [![Python Package](https://github.com/ptrstn/shellsmith/actions/workflows/python-package.yaml/badge.svg)](https://github.com/ptrstn/shellsmith/actions/workflows/python-package.yaml)
@@ -92,8 +94,12 @@ Common commands:
 ```bash
 aas info                  # Show all shells and submodels
 aas upload <file|folder>  # Upload AAS file or folder
+
 aas shell delete <id>     # Delete a shell
 aas submodel delete <id>  # Delete a submodel
+
+aas sme get <id> <path>               # Get Submodel element value
+aas sme patch <id> <path> <new_value> # Set Submodel element value
 ```
 
 Use `--cascade` or `--unlink` to control deletion behavior:

{shellsmith-0.1.0 → shellsmith-0.2.1}/src/shellsmith.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 src/shellsmith/__init__.py
 src/shellsmith/__main__.py
 src/shellsmith/config.py
+src/shellsmith/neo4j.py
 src/shellsmith/services.py
 src/shellsmith/upload.py
 src/shellsmith/utils.py
@@ -20,6 +21,7 @@ src/shellsmith/cli/commands/__init__.py
 src/shellsmith/cli/commands/info.py
 src/shellsmith/cli/commands/nuke.py
 src/shellsmith/cli/commands/shell.py
+src/shellsmith/cli/commands/sme.py
 src/shellsmith/cli/commands/submodel.py
 src/shellsmith/cli/commands/upload.py
 src/shellsmith/crud/__init__.py
@@ -28,5 +30,6 @@ src/shellsmith/crud/submodels.py
 tests/test_cli.py
 tests/test_cli_integration.py
 tests/test_crud.py
+tests/test_neo4j.py
 tests/test_upload.py
 tests/test_utils.py

{shellsmith-0.1.0 → shellsmith-0.2.1}/src/shellsmith.egg-info/requires.txt

@@ -1,6 +1,9 @@
 pydantic-settings
 requests
 
+[neo4j]
+neo4j
+
 [test]
 black
 flake8

shellsmith-0.2.1/tests/test_neo4j.py

@@ -0,0 +1,138 @@
+import os
+import time
+
+import pytest
+
+if not os.getenv("SHELLSMITH_NEO4J_ENABLED"):
+    pytest.skip(
+        reason="Skipping Neo4j tests. Set SHELLSMITH_NEO4J_ENABLED=1 to enable.",
+        allow_module_level=True,
+    )
+
+from shellsmith import neo4j, services
+from shellsmith.upload import upload_aas_folder
+
+
+GRAPH_READY_TIMEOUT = 45  # seconds
+EXPECTED_NODE_COUNT = 39
+EXPECTED_SUBMODEL_ELEMENT_COUNT = 17  # or whatever your total is
+
+
+def wait_for_graph_node_count(
+    expected_count: int = EXPECTED_NODE_COUNT,
+    timeout: int = GRAPH_READY_TIMEOUT,
+) -> (bool, int):
+    query = "MATCH (n) RETURN count(n) AS count"
+    start = time.time()
+
+    last_count = 0
+
+    while True:
+        try:
+            with neo4j.get_driver().session() as session:
+                result = session.run(query)
+                record = result.single()
+                count = record["count"]
+                last_count = count
+                if record and count == expected_count:
+                    return True, last_count
+        except Exception:  # noqa
+            pass  # wait and retry
+
+        if time.time() - start > timeout:
+            return False, last_count
+
+        time.sleep(0.5)
+
+
+def test_wait_for_graph():
+    # neo4j.detach_delete_all()
+    services.delete_all_shells()
+    services.delete_all_submodels()
+    success, count = wait_for_graph_node_count(0)
+    assert success, f"Graph was not fully destructed within timeout: {count}"
+
+    upload_aas_folder("aas")
+    success, count = wait_for_graph_node_count(39)
+    assert success, f"Graph was not fully built within timeout: {count}"
+    time.sleep(1)
+
+
+def test_get_shells(semitrailer, workpiece_carrier_a1):
+    shells = neo4j.get_shells()
+    assert len(shells) == 2
+
+    shell_id_shorts = {shell["idShort"] for shell in shells}
+    shell_ids = {shell["id"] for shell in shells}
+    assert semitrailer.id in shell_ids
+    assert workpiece_carrier_a1.id in shell_ids
+    assert semitrailer.id_short in shell_id_shorts
+    assert workpiece_carrier_a1.id_short in shell_id_shorts
+
+
+def test_get_shell(
+    semitrailer,
+    workpiece_carrier_a1,
+):
+    shell = neo4j.get_shell(semitrailer.id)
+    assert shell["id"] == semitrailer.id
+    assert shell["idShort"] == semitrailer.id_short
+
+    shell = neo4j.get_shell(workpiece_carrier_a1.id)
+    assert shell["id"] == workpiece_carrier_a1.id
+    assert shell["idShort"] == workpiece_carrier_a1.id_short
+
+
+def test_get_submodels(semitrailer, workpiece_carrier_a1):
+    submodels = neo4j.get_submodels()
+    assert len(submodels) == 4
+
+
+def test_get_submodel(
+    semitrailer,
+    workpiece_carrier_a1,
+):
+    submodel = neo4j.get_submodel(semitrailer.product_identification.id)
+    assert submodel["idShort"] == semitrailer.product_identification.id_short
+
+    submodel = neo4j.get_submodel(semitrailer.production_plan.id)
+    assert submodel["idShort"] == semitrailer.production_plan.id_short
+
+    submodel = neo4j.get_submodel(workpiece_carrier_a1.good_information.id)
+    assert submodel["idShort"] == workpiece_carrier_a1.good_information.id_short
+
+    submodel = neo4j.get_submodel(workpiece_carrier_a1.asset_location.id)
+    assert submodel["idShort"] == workpiece_carrier_a1.asset_location.id_short
+
+
+def test_get_submodel_elements(semitrailer, workpiece_carrier_a1):
+    elements = neo4j.get_submodel_elements(semitrailer.product_identification.id)
+    assert len(elements) == 2
+    id_shorts = {el["idShort"] for el in elements}
+    assert "Identifier" in id_shorts
+    assert "ProductName" in id_shorts
+
+    elements = neo4j.get_submodel_elements(workpiece_carrier_a1.good_information.id)
+    assert len(elements) == 7
+    id_shorts = {el["idShort"] for el in elements}
+    assert "CurrentProduct" in id_shorts
+    assert "ListTransportableProducts" in id_shorts
+    assert "ProductName" in id_shorts
+
+
+def test_get_submodel_element(semitrailer, workpiece_carrier_a1):
+    element = neo4j.get_submodel_element(
+        semitrailer.product_identification.id, "ProductName"
+    )
+    assert element["idShort"] == "ProductName"
+    assert element["value"] == "Semitrailer"
+
+    element = neo4j.get_submodel_element(
+        workpiece_carrier_a1.asset_location.id, "CurrentFences[0].FenceName"
+    )
+    assert element["idShort"] == "FenceName"
+    assert element["value"] == "TSN-Module"
+
+
+def test_close_driver():
+    neo4j.close_driver()