shellsmith 0.1.0__py3-none-any.whl

shellsmith/__init__.py

@@ -0,0 +1,18 @@
+__version__ = "0.1.0"
+
+from .crud.shells import (  # noqa: F401
+    delete_shell,
+    delete_submodel_ref,
+    get_shell,
+    get_shells,
+    get_submodel_refs,
+)
+from .crud.submodels import (  # noqa: F401
+    delete_submodel,
+    delete_submodel_element,
+    get_submodel,
+    get_submodel_element,
+    get_submodel_elements,
+    get_submodels,
+    patch_submodel_element_value,
+)

shellsmith/__main__.py

@@ -0,0 +1,4 @@
+from shellsmith.cli.main import main
+
+if __name__ == "__main__":
+    main()

shellsmith/cli/commands/__init__.py

@@ -0,0 +1,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 .upload import upload  # noqa: F401

shellsmith/cli/commands/info.py

@@ -0,0 +1,47 @@
+import shellsmith
+from shellsmith import services
+
+
+def info():
+    print("ℹ️ Showing all shells")
+    print_shells_tree()
+    print_unreferenced_submodels()
+    print_dangling_submodel_refs()
+
+
+def print_unreferenced_submodels():
+    submodel_ids = services.find_unreferenced_submodels()
+
+    if submodel_ids:
+        print()
+        print("⚠️ Unreferenced Submodels:")
+        for submodel_id in submodel_ids:
+            submodel = shellsmith.get_submodel(submodel_id)
+            id_short = submodel["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']}")
+
+        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']}")
+
+
+def print_dangling_submodel_refs():
+    dangling = services.find_dangling_submodel_refs()
+
+    if dangling:
+        print()
+        print("⚠️ Dangling Submodel References:")
+        for shell_id, submodel_ids in dangling.items():
+            shell = shellsmith.get_shell(shell_id)
+            print(f"- {shell['idShort']}: {shell_id}")
+            for submodel_id in submodel_ids:
+                print(f"  └── {submodel_id}")

shellsmith/cli/commands/nuke.py

@@ -0,0 +1,9 @@
+from shellsmith import services
+
+
+def nuke():
+    print("☣️ Deleting all Shells and Submodels!")
+    print("☢️ Deleting all Shells and Submodels!")
+    print("⚠️ Deleting all Shells and Submodels!")
+    services.delete_all_shells()
+    services.delete_all_submodels()

shellsmith/cli/commands/shell.py

@@ -0,0 +1,17 @@
+import requests.exceptions
+
+import shellsmith
+from shellsmith import services
+
+
+def shell_delete(shell_id: str, cascade: bool = False):
+    print(f"🗑️ Deleting Shell: {shell_id}")
+    try:
+        if cascade:
+            services.delete_shell_cascading(shell_id)
+            print(f"✅ Shell '{shell_id}' and its submodels deleted.")
+        else:
+            shellsmith.delete_shell(shell_id)
+            print(f"✅ Shell '{shell_id}' deleted.")
+    except requests.exceptions.HTTPError as e:
+        print(f"❌ Failed to delete Shell '{shell_id}': {e}")

shellsmith/cli/commands/submodel.py

@@ -0,0 +1,16 @@
+import requests
+
+import shellsmith
+from shellsmith import services
+
+
+def submodel_delete(submodel_id: str, unlink: bool = False):
+    print(f"🗑️ Deleting Submodel: {submodel_id}")
+    try:
+        shellsmith.delete_submodel(submodel_id)
+        print(f"✅ Submodel '{submodel_id}' deleted.")
+    except requests.exceptions.HTTPError:
+        print(f"❌ Submodel '{submodel_id}' doesn't exist.")
+    if unlink:
+        services.remove_submodel_references(submodel_id)
+        print(f"✅ Removed Shell references to Submodel '{submodel_id}'.")

shellsmith/cli/commands/upload.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+
+from shellsmith.upload import upload_aas, upload_aas_folder
+
+
+def upload(path: Path):
+    if path.is_file():
+        print(f"ℹ️ Uploading file: {path}")
+        upload_aas(path)
+    elif path.is_dir():
+        print(f"ℹ️ Uploading all AAS files in folder: {path}")
+        upload_aas_folder(path)
+    else:
+        print(f"❌ Path '{path}' does not exist or is invalid.")

shellsmith/cli/main.py

@@ -0,0 +1,44 @@
+import requests
+
+from shellsmith import __version__, services
+from shellsmith.config import config
+
+from .commands import info, nuke, shell_delete, submodel_delete, upload
+from .parser import build_parser
+
+
+def print_header():
+    print("===============================================")
+    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()
+
+    commands = {
+        "upload": lambda _args: upload(args.path),
+        "info": lambda _args: info(),
+        "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),
+    }
+
+    try:
+        key = args.command
+        if key == "shell" and args.shell_command:
+            key += f".{args.shell_command}"
+        elif key == "submodel" and args.submodel_command:
+            key += f".{args.submodel_command}"
+
+        handler = commands.get(key)
+        if handler:
+            handler(args)
+        else:
+            parser.print_help()
+    except requests.exceptions.ConnectionError as e:
+        print(f"😩 Cannot reach {config.host}: {e}")

shellsmith/cli/parser.py

@@ -0,0 +1,63 @@
+import argparse
+from pathlib import Path
+
+from shellsmith import __version__
+
+
+def build_parser():
+    parser = argparse.ArgumentParser(description="AAS Tools CLI")
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s v{__version__}",
+    )
+    subparsers = parser.add_subparsers(dest="command", help="Available commands")
+
+    # ──────────────────────────── upload ────────────────────────────
+    upload_parser = subparsers.add_parser("upload", help="Upload AAS file or folder")
+    upload_parser.add_argument("path", type=Path, help="Path to the AAS file or folder")
+
+    # ───────────────────────────── info ─────────────────────────────
+    subparsers.add_parser("info", help="Display all AAS shells and their submodels")
+
+    # ───────────────────────────── nuke ─────────────────────────────
+    subparsers.add_parser("nuke", help="Delete all AAS shells and submodels")
+
+    # ──────────────────────────── shell ─────────────────────────────
+    shell_parser = subparsers.add_parser(
+        "shell",
+        help="Manage Asset Administration Shells",
+    )
+    shell_subparsers = shell_parser.add_subparsers(dest="shell_command")
+    shell_delete_parser = shell_subparsers.add_parser(
+        "delete",
+        help="Delete an AAS Shell by ID",
+    )
+    shell_delete_parser.add_argument("id", type=str, help="ID of the shell to delete")
+    shell_delete_parser.add_argument(
+        "--cascade",
+        "-c",
+        action="store_true",
+        help="Also delete all referenced submodels",
+    )
+
+    # ───────────────────────────── submodel ─────────────────────────────
+    submodel_parser = subparsers.add_parser("submodel", help="Manage Submodels")
+    submodel_subparsers = submodel_parser.add_subparsers(dest="submodel_command")
+    submodel_delete_parser = submodel_subparsers.add_parser(
+        "delete",
+        help="Delete a Submodel by ID",
+    )
+    submodel_delete_parser.add_argument(
+        "id",
+        type=str,
+        help="ID of the submodel to delete",
+    )
+    submodel_delete_parser.add_argument(
+        "--unlink",
+        "-u",
+        action="store_true",
+        help="Remove all Shell references to this Submodel",
+    )
+
+    return parser

shellsmith/config.py

@@ -0,0 +1,15 @@
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    basyx_env_host: str = "http://localhost:8081"
+    neo4j_uri: str = "neo4j://localhost:7687"
+
+    @property
+    def host(self):
+        return self.basyx_env_host
+
+    model_config = SettingsConfigDict(env_file=".env", env_prefix="SHELLSMITH_")
+
+
+config = Settings()

shellsmith/crud/shells.py

@@ -0,0 +1,61 @@
+from typing import Dict, List
+
+import requests
+
+from shellsmith.config import config
+from shellsmith.utils import base64_encoded
+
+
+def get_shells(host: str = config.host) -> List[Dict]:
+    url = f"{host}/shells"
+    response = requests.get(url)
+    response.raise_for_status()
+    json_response = response.json()
+    shells = json_response["result"]
+    return shells
+
+
+def get_shell(shell_id, encode=True, host: str = config.host) -> Dict:
+    shell_id = base64_encoded(shell_id, encode)
+    url = f"{host}/shells/{shell_id}"
+
+    response = requests.get(url)
+    response.raise_for_status()
+    shell = response.json()
+    return shell
+
+
+def delete_shell(shell_id: str, encode=True, host: str = config.host):
+    shell_id = base64_encoded(shell_id, encode)
+
+    url = f"{host}/shells/{shell_id}"
+    response = requests.delete(url)
+    response.raise_for_status()
+
+
+def get_submodel_refs(
+    shell_id: str,
+    encode=True,
+    host: str = config.host,
+):
+    shell_id = base64_encoded(shell_id, encode)
+
+    url = f"{host}/shells/{shell_id}/submodel-refs"
+    response = requests.get(url)
+    response.raise_for_status()
+    submodel_refs = response.json()["result"]
+    return submodel_refs
+
+
+def delete_submodel_ref(
+    shell_id: str,
+    submodel_id,
+    encode=True,
+    host: str = config.host,
+):
+    shell_id = base64_encoded(shell_id, encode)
+    submodel_id = base64_encoded(submodel_id, encode)
+
+    url = f"{host}/shells/{shell_id}/submodel-refs/{submodel_id}"
+    response = requests.delete(url)
+    response.raise_for_status()

shellsmith/crud/submodels.py

@@ -0,0 +1,126 @@
+from typing import Dict, List
+from urllib.parse import quote
+
+import requests
+
+from shellsmith.config import config
+from shellsmith.utils import base64_encoded
+
+
+def get_submodels(host: str = config.host) -> List[Dict]:
+    """
+    Returns all Submodels
+
+    GET /submodels
+    """
+    url = f"{host}/submodels"
+
+    response = requests.get(url)
+    response.raise_for_status()
+    json_response = response.json()
+    submodels = json_response["result"]
+    return submodels
+
+
+def get_submodel(submodel_id: str, encode=True, host: str = config.host) -> Dict:
+    """
+    Returns a specific Submodel
+
+    GET /submodels/{submodel_id}
+    """
+    submodel_id = base64_encoded(submodel_id, encode)
+    url = f"{host}/submodels/{submodel_id}"
+
+    response = requests.get(url)
+    response.raise_for_status()
+    submodel = response.json()
+    return submodel
+
+
+def delete_submodel(submodel_id: str, encode=True, host: str = config.host):
+    """
+    Deletes a specific Submodel
+
+    DELETE /submodels/{submodel_id}
+    """
+    submodel_id = base64_encoded(submodel_id, encode)
+    url = f"{host}/submodels/{submodel_id}"
+
+    response = requests.delete(url)
+    response.raise_for_status()
+
+
+# ─────────────────────────── Submodel elements ───────────────────────────
+
+
+def get_submodel_elements(submodel_id: str, encode=True, host: str = config.host):
+    """
+    Returns all submodel elements of a specific Submodel
+
+    GET /submodels/{submodel_id}/submodel-elements
+    """
+    submodel_id = base64_encoded(submodel_id, encode)
+    url = f"{host}/submodels/{submodel_id}/submodel-elements"
+
+    response = requests.get(url)
+    response.raise_for_status()
+    json_response = response.json()
+    elements = json_response["result"]
+    return elements
+
+
+def get_submodel_element(
+    submodel_id: str, id_short_path: str, encode=True, host: str = config.host
+):
+    """
+    Returns all submodel elements including their hierarchy
+
+    GET /submodels/{submodel_id}/submodel-elements/{id_short_path}
+    """
+    submodel_id = base64_encoded(submodel_id, encode)
+    url = f"{host}/submodels/{submodel_id}/submodel-elements/{id_short_path}"
+
+    response = requests.get(url)
+    response.raise_for_status()
+    element = response.json()
+    return element
+
+
+def delete_submodel_element(
+    submodel_id: str,
+    id_short_path: str,
+    value: str,
+    encode=True,
+    host: str = config.host,
+):
+    """
+    Deletes a submodel element at a specified path
+
+    DELETE /submodels/{submodel_id}/submodel-elements/{idShortPath}
+    """
+    submodel_id = base64_encoded(submodel_id, encode)
+    id_short_path = quote(id_short_path)
+
+    url = f"{host}/submodels/{submodel_id}/submodel-elements/{id_short_path}"
+    response = requests.delete(url, json=value)
+    response.raise_for_status()
+
+
+def patch_submodel_element_value(
+    submodel_id: str,
+    id_short_path: str,
+    value: str,
+    encode=True,
+    host: str = config.host,
+):
+    """
+    Updates the value of an existing Submodel Element
+
+    PATCH /submodels/{submodel_id}/submodel-elements/{id_short_path}/$value
+    """
+    submodel_id = base64_encoded(submodel_id, encode)
+    id_short_path = quote(id_short_path)
+    url = f"{host}/submodels/{submodel_id}" f"/submodel-elements/{id_short_path}/$value"
+
+    response = requests.patch(url, json=value)
+    response.raise_for_status()

shellsmith/services.py

@@ -0,0 +1,131 @@
+from typing import Dict, List
+
+import requests
+
+import shellsmith
+from shellsmith.config import config
+
+
+def get_shell_submodels(shell_id: str) -> List[Dict]:
+    shell = shellsmith.get_shell(shell_id)
+    if "submodels" not in shell:
+        return []
+
+    submodel_ids = extract_shell_submodel_refs(shell)
+    submodels: List[Dict] = []
+
+    for submodel_id in submodel_ids:
+        try:
+            submodel = shellsmith.get_submodel(submodel_id)
+            submodels.append(submodel)
+        except requests.exceptions.HTTPError:
+            print(f"⚠️  Submodel '{submodel_id}' not found")
+
+    return submodels
+
+
+def delete_shell_cascading(
+    shell_id: str,
+    host: str = config.host,
+):
+    delete_submodels_of_shell(shell_id, host=host)
+    shellsmith.delete_shell(shell_id, host=host)
+
+
+def delete_submodels_of_shell(
+    shell_id: str,
+    host: str = config.host,
+):
+    shell = shellsmith.get_shell(shell_id, host=host)
+
+    if "submodels" in shell:
+        for submodel in shell["submodels"]:
+            submodel_id = submodel["keys"][0]["value"]
+            try:
+                shellsmith.delete_submodel(submodel_id, host=host)
+            except requests.exceptions.HTTPError:
+                print(f"Warning: Submodel {submodel_id} doesn't exist")
+
+
+def remove_submodel_references(submodel_id: str):
+    shells = shellsmith.get_shells()
+    for shell in shells:
+        if submodel_id in extract_shell_submodel_refs(shell):
+            shellsmith.delete_submodel_ref(shell["id"], submodel_id)
+
+
+def remove_dangling_submodel_refs():
+    shells = shellsmith.get_shells()
+    submodels = shellsmith.get_submodels()
+    submodel_ids = {submodel["id"] for submodel in submodels}
+
+    for shell in shells:
+        for submodel_id in extract_shell_submodel_refs(shell):
+            if submodel_id not in submodel_ids:
+                shellsmith.delete_submodel_ref(shell["id"], submodel_id)
+
+
+def delete_all_submodels(host: str = config.host):
+    submodels = shellsmith.get_submodels(host=host)
+    for submodel in submodels:
+        shellsmith.delete_submodel(submodel["id"])
+
+
+def delete_all_shells(host: str = config.host):
+    shells = shellsmith.get_shells()
+    for shell in shells:
+        shellsmith.delete_shell(shell["id"], host=host)
+
+
+def health(timeout: float = 0.1) -> str:
+    url = f"{config.host}/actuator/health"
+
+    try:
+        response = requests.get(url, timeout=timeout)
+        response.raise_for_status()
+        data = response.json()
+        return data["status"]
+    except requests.exceptions.ConnectionError:
+        return "DOWN"
+
+
+def extract_shell_submodel_refs(shell: Dict) -> List[str]:
+    return [
+        submodel["keys"][0]["value"]
+        for submodel in shell["submodels"]
+        if "submodels" in shell
+    ]
+
+
+def find_unreferenced_submodels() -> list[str]:
+    shells = shellsmith.get_shells()
+    submodels = shellsmith.get_submodels()
+
+    submodel_ref_ids = {
+        submodel_id
+        for shell in shells
+        for submodel_id in extract_shell_submodel_refs(shell)
+    }
+
+    submodel_ids = {submodel["id"] for submodel in submodels}
+    return list(submodel_ids - submodel_ref_ids)
+
+
+def find_dangling_submodel_refs() -> dict[str, list[str]]:
+    """
+    Returns a mapping of shell_id -> list of submodel IDs
+    that are referenced in the shell but do not exist anymore.
+    """
+    shells = shellsmith.get_shells()
+    submodels = shellsmith.get_submodels()
+    existing_submodel_ids = {submodel["id"] for submodel in submodels}
+
+    dangling_refs: dict[str, list[str]] = {}
+
+    for shell in shells:
+        shell_id = shell["id"]
+        for submodel_id in extract_shell_submodel_refs(shell):
+            if submodel_id not in existing_submodel_ids:
+                dangling_refs.setdefault(shell_id, []).append(submodel_id)
+
+    return dangling_refs

shellsmith/upload.py

@@ -0,0 +1,40 @@
+import mimetypes
+from pathlib import Path
+
+import requests
+
+from shellsmith.config import config
+
+
+def upload_aas_folder(path: Path | str):
+    folder_path = Path(path)
+
+    if not folder_path.is_dir():
+        raise ValueError(f"{folder_path} is not a valid directory.")
+
+    for aas_file in folder_path.iterdir():
+        if aas_file.is_file() and aas_file.suffix in {".json", ".xml", ".aasx"}:
+            print(f"Uploading: '{aas_file.name}'")
+            upload_aas(aas_file)
+
+
+def upload_aas(path: Path | str):
+    path = Path(path)
+    url = f"{config.host}/upload"
+
+    mime_type, _ = mimetypes.guess_type(path)
+    if mime_type is None:
+        # .aasx
+        mime_type = "application/octet-stream"
+
+    with open(path, "rb") as file:
+        files = [("file", (path.name, file, mime_type))]
+        try:
+            response = requests.post(url, files=files)
+            response.raise_for_status()
+            success = response.json()
+            print(f"✅ Successfully uploaded '{path.name}': {success}")
+            return success
+        except requests.exceptions.HTTPError as e:
+            print(f"❌ Failed to upload '{path.name}': {e}")
+            return False

shellsmith/utils.py

@@ -0,0 +1,35 @@
+import base64
+from typing import Optional
+
+
+def base64_encode(text: Optional[str]) -> Optional[str]:
+    try:
+        return (
+            base64.urlsafe_b64encode(text.encode("utf-8"))
+            .decode("utf-8")
+            .rstrip("=")  # padding character if input long multiple of 3
+        )
+    except (TypeError, AttributeError) as e:
+        if text is None:
+            return None
+        raise e
+
+
+def base64_decode(encoded_text: Optional[str]) -> Optional[str]:
+    try:
+        missing_padding = 4 - (len(encoded_text) % 4)
+        if missing_padding > 0:
+            encoded_text += "=" * missing_padding
+        return base64.urlsafe_b64decode(encoded_text).decode("utf-8")
+    except TypeError as e:
+        if encoded_text is None:
+            return None
+        raise e
+
+
+def base64_encoded(identifier: str, encode: bool) -> str:
+    """
+    Return the base64-encoded identifier if encode is True;
+    otherwise, return it unchanged.
+    """
+    return base64_encode(identifier) if encode else identifier

shellsmith-0.1.0.dist-info/METADATA

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: shellsmith
+Version: 0.1.0
+Summary: A Python toolkit and CLI for managing Asset Administration Shells
+Author-email: Peter Stein <peterstein@dfki.de>
+License: MIT License
+        
+        Copyright (c) 2025 Peter Stein
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/ptrstn/shellsmith
+Project-URL: Issues, https://github.com/ptrstn/shellsmith/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic-settings
+Requires-Dist: requests
+Provides-Extra: test
+Requires-Dist: black; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: isort; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-dotenv; extra == "test"
+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)
+[![codecov](https://codecov.io/gh/ptrstn/shellsmith/branch/main/graph/badge.svg)](https://codecov.io/gh/ptrstn/shellsmith)
+[![PyPI version](https://badge.fury.io/py/shellsmith.svg)](https://badge.fury.io/py/shellsmith)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+# Shellsmith
+
+Shellsmith is a Python toolkit and CLI for managing Asset Administration Shells (AAS), Submodels, and related resources. 
+It is designed to interact with [Eclipse BaSyx](https://www.eclipse.org/basyx/), a middleware platform for AAS that follows the [Industry 4.0 standard](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).
+
+### Features
+
+- Python API for CRUD operations on shells, submodels, and submodel elements
+- CLI interface for quick scripting
+- `.env`-based configuration
+
+## 🚀 Installation
+
+```bash
+pip install shellsmith
+```
+
+**Requires**: Python 3.10+
+
+## 🔧 Configuration
+
+The default AAS environment host is:
+
+```
+http://localhost:8081
+```
+
+You can override it by setting the `SHELLSMITH_BASYX_ENV_HOST` environment variable, or by creating a `.env` file in your project root with:
+
+```bash
+SHELLSMITH_BASYX_ENV_HOST=http://your-host:1234
+```
+
+## 🛠️ Usage
+
+```bash
+aas --help
+```
+
+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
+```
+
+Use `--cascade` or `--unlink` to control deletion behavior:
+
+```bash
+aas shell delete <id> --cascade      # Also delete referenced submodels
+aas submodel delete <id> --unlink    # Remove references from shells
+```
+
+## 📡 API Usage
+
+You can also use `shellsmith` as a Python package:
+
+```python
+import shellsmith
+
+# Get all available shells
+shells = shellsmith.get_shells()
+
+# Get a specific shell by ID (automatically base64-encoded)
+shell = shellsmith.get_shell("example_aas_id")
+
+# Disable base64 encoding if your ID is already encoded
+submodel = shellsmith.get_submodel("ZXhhbXBsZV9hYXNfaWQ=", encode=False)
+
+# Use a custom AAS environment host
+submodel_refs = shellsmith.get_submodel_refs("example_aas_id", host="http://localhost:8081")
+```
+
+> ℹ️ `shell_id` and `submodel_id` are automatically base64-encoded unless you set `encode=False`. This is required by the BaSyx API for identifier-based URLs.
+
+The tables below show the mapping between BaSyx AAS REST API endpoints and the implemented client functions.
+
+> 📚 See [Plattform_i40 API reference](https://app.swaggerhub.com/apis/Plattform_i40/Entire-API-Collection) for endpoint details.
+
+### Shells
+
+| Method | BaSyx Endpoint                                               | Shellsmith Function   |
+|--------|--------------------------------------------------------------|-----------------------|
+| GET    | `/shells`                                                    | `get_shells`          |
+| POST   | `/shells`                                                    | ❌                     |
+| GET    | `/shells/{aasIdentifier}`                                    | `get_shell`           |
+| PUT    | `/shells/{aasIdentifier}`                                    | ❌                     |
+| DELETE | `/shells/{aasIdentifier}`                                    | `delete_shell`        |
+| GET    | `/shells/{aasIdentifier}/submodel-refs`                      | `get_submodel_refs`   |
+| POST   | `/shells/{aasIdentifier}/submodel-refs`                      | ❌                     |
+| DELETE | `/shells/{aasIdentifier}/submodel-refs/{submodelIdentifier}` | `delete_submodel_ref` |
+
+### Submodels
+
+| Method | BaSyx Endpoint                              | Shellsmith Function |
+|--------|---------------------------------------------|---------------------|
+| GET    | `/submodels`                                | `get_submodels`     |
+| POST   | `/submodels`                                | ❌                   |
+| GET    | `/submodels/{submodelIdentifier}`           | `get_submodel`      |
+| PUT    | `/submodels/{submodelIdentifier}`           | ❌                   |
+| DELETE | `/submodels/{submodelIdentifier}`           | `delete_submodel`   |
+| GET    | `/submodels/{submodelIdentifier}/$value`    | ❌                   |
+| PATCH  | `/submodels/{submodelIdentifier}/$value`    | ❌                   |
+| GET    | `/submodels/{submodelIdentifier}/$metadata` | ❌                   |
+
+### Submodel Elements
+
+| Method | BaSyx Endpoint                                                           | Shellsmith Function            |
+|--------|--------------------------------------------------------------------------|--------------------------------|
+| GET    | `/submodels/{submodelIdentifier}/submodel-elements`                      | `get_submodel_elements`        |
+| POST   | `/submodels/{submodelIdentifier}/submodel-elements`                      | ❌                              |
+| GET    | `/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}`        | `get_submodel_element`         |
+| PUT    | `/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}`        | ❌                              |
+| POST   | `/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}`        | ❌                              |
+| DELETE | `/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}`        | `delete_submodel_element`      |
+| GET    | `/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value` | ❌                              |
+| PATCH  | `/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value` | `patch_submodel_element_value` |
+
+### Upload
+
+| Method | BaSyx Endpoint | Shellsmith Function                                 |
+|--------|----------------|-----------------------------------------------------|
+| POST   | `/upload`      | `upload.upload_aas` <br> `upload.upload_aas_folder` |
+
+> ℹ️ Upload functions are available under the `shellsmith.upload` submodule.
+
+## ⚙️ Development
+
+```bash
+git clone https://github.com/ptrstn/shellsmith
+cd shellsmith
+python -m venv .venv
+source .venv/bin/activate    # or .venv\Scripts\activate on Windows
+pip install -e .[test]
+```
+
+### ✅ Testing
+
+Before running the tests, make sure the BaSyx stack is up and running:
+
+```bash
+docker compose up -d
+```
+
+Then run the test suite with coverage:
+
+```bash
+pytest --cov
+```
+
+To view a detailed, visual coverage report:
+
+```bash
+pytest --cov --cov-report=html
+```
+
+Then open `htmlcov/index.html` in your web browser to explore which lines are covered and which are missing.
+
+## Resources
+
+- https://github.com/eclipse-basyx/basyx-java-server-sdk
+- https://github.com/admin-shell-io/aas-specs-api
+- https://app.swaggerhub.com/apis/Plattform_i40/Entire-API-Collection

shellsmith-0.1.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+shellsmith/__init__.py,sha256=cgAbE5dd7c9JHg5tQzh2nk8aPGLkYxrKv9FgpYhjHdU,383
+shellsmith/__main__.py,sha256=9-8Zh6cInl-4TDL8Dc-pyS9mM2japglycAa2lqq7qy4,76
+shellsmith/config.py,sha256=EzDrxpCUVs7MPHIhE68OL9iiCjfSlA-m1sDGKp5gyl8,365
+shellsmith/services.py,sha256=D0Pz_17pd5f018djXKpVwBcVH6zyYNRKjzD4Eps00ak,3833
+shellsmith/upload.py,sha256=w79XYBFU1BZ1rhkFjfAYi1RwLkEs8Y6UhVG6tWnSRqc,1186
+shellsmith/utils.py,sha256=yP1qzk0_k8TdB6y7QrVRj43rKuMInwKp8TR7c0U3qz8,1026
+shellsmith/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+shellsmith/cli/main.py,sha256=P-jfSmSEMdPlK7ib6iYxnAZxGPoprct7Qo2LOP8ReGI,1357
+shellsmith/cli/parser.py,sha256=CSrzvEnoKNmqf6011VcTQnhzjlahk4DRjk56T3umjFw,2805
+shellsmith/cli/commands/__init__.py,sha256=Fjs4QXdP5SlgZeuI1S9w_L3fu2bKGpXG7z-NntS4Zeo,213
+shellsmith/cli/commands/info.py,sha256=9O783zMvZcDccSDi6S3z04CboVhc-P_3f-Mzf5PgL2A,1445
+shellsmith/cli/commands/nuke.py,sha256=H9WnUN6X3a9_Guo22vEkdtbvQceh6u2fhRuNPyqBkaE,280
+shellsmith/cli/commands/shell.py,sha256=GACLGrWyLzEq0WO_jG1VvUu9cKG6FLLBrwYTLJS0-wU,564
+shellsmith/cli/commands/submodel.py,sha256=GQq8WC2q2hy8OUk22szRfvrXbnUpNFxAJwYCXDVJkgY,550
+shellsmith/cli/commands/upload.py,sha256=DcooOCfX9RnWCfR_f3iLaQ6i1o7CMWv2PmiRBG8j6CQ,407
+shellsmith/crud/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+shellsmith/crud/shells.py,sha256=cHuKhHf1Eo5jmApHbrwt4QahgIxAvjlvBJsRfDf1IIs,1546
+shellsmith/crud/submodels.py,sha256=IJY8PJdPKjsIruv-luxLz-OWgKQO0b3dPHYvdwSqFyI,3451
+shellsmith-0.1.0.dist-info/licenses/LICENSE,sha256=_FYnm0XtBFVmy-ujEvLeCQyhtX9TwxwqsRpSqtayqwE,1068
+shellsmith-0.1.0.dist-info/METADATA,sha256=7ED7fzluSNxMwoOc-6CSTv8B2t8Pe348ZxjkywMigjY,9293
+shellsmith-0.1.0.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+shellsmith-0.1.0.dist-info/entry_points.txt,sha256=ezYPS3a9PsteA-0j5M0uybQvekGpoCqvuKZ8BPYK0sY,49
+shellsmith-0.1.0.dist-info/top_level.txt,sha256=DSeEc6iCej548xSglvE-AA5TP1AzaXQy9z3awRnCJHc,11
+shellsmith-0.1.0.dist-info/RECORD,,

shellsmith-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (77.0.3)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

shellsmith-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+aas = shellsmith.cli.main:main

shellsmith-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Peter Stein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

shellsmith-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+shellsmith