shellsmith 0.4.0__tar.gz → 0.5.0__tar.gz

{shellsmith-0.4.0 → shellsmith-0.5.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: shellsmith
-Version: 0.4.0
-Summary: A Python SDK and CLI for Eclipse BaSyx to manage Asset Administration Shells (AAS)
+Version: 0.5.0
+Summary: A Python SDK for Eclipse BaSyx to manage Asset Administration Shells (AAS)
 Project-URL: Homepage, https://github.com/SmartFactory-KL/shellsmith
 Project-URL: Issues, https://github.com/SmartFactory-KL/shellsmith/issues
 Project-URL: Documentation, https://shellsmith.pages.dev
@@ -28,7 +28,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
-Keywords: aas,asset-administration-shell,basyx,cli,digital-twin,eclipse-basyx,i40,industry40,python,rest-client,typer
+Keywords: aas,asset-administration-shell,basyx,digital-twin,eclipse-basyx,i40,industry40,python,rest-client
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -41,15 +41,17 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
-Requires-Dist: fastmcp
 Requires-Dist: httpx
 Requires-Dist: pydantic-settings
 Requires-Dist: pyyaml
-Requires-Dist: typer
+Provides-Extra: cli
+Requires-Dist: aas-cli; extra == 'cli'
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == 'docs'
 Requires-Dist: mkdocs-material; extra == 'docs'
 Requires-Dist: termynal; extra == 'docs'
+Provides-Extra: mcp
+Requires-Dist: aas-mcp; extra == 'mcp'
 Provides-Extra: neo4j
 Requires-Dist: neo4j; extra == 'neo4j'
 Provides-Extra: test
@@ -64,7 +66,7 @@ Requires-Dist: types-requests; extra == 'test'
 Description-Content-Type: text/markdown
 
 <div align="center">
-    <img src="https://raw.githubusercontent.com/SmartFactory-KL/shellsmith/main/docs/images/logo-purple-500.png" alt="shellsmith">
+    <img src="https://raw.githubusercontent.com/SmartFactory-KL/shellsmith/main/docs/images/banner-purple-500.png" alt="shellsmith">
 </div>
 
 <div align="center">
@@ -78,26 +80,45 @@ Description-Content-Type: text/markdown
     <b>Documentation</b>: <a href="https://shellsmith.pages.dev/" target="_blank">https://shellsmith.pages.dev</a>
 </p>
 
-**Shellsmith** is a Python SDK and CLI for managing [Asset Administration Shells (AAS)](https://industrialdigitaltwin.org/en/content-hub/aasspecifications), Submodels, and Submodel Elements via the [Eclipse BaSyx](https://www.eclipse.org/basyx/) REST API.  
- 
-It provides full client-side access to AAS resources with a clean Python interface and a powerful `typer`-based CLI — ideal for scripting, automation, and digital twin integration workflows.
+**Shellsmith** is a Python SDK for managing [Asset Administration Shells (AAS)](https://industrialdigitaltwin.org/en/content-hub/aasspecifications) via the [Eclipse BaSyx](https://www.eclipse.org/basyx/) REST API.
 
-### Features
+## Installation
 
-- 🐍 **Python SDK** for full CRUD access to Shells, Submodels, and Submodel Elements  
-- ⚡ **CLI tool** powered by [Typer](https://typer.tiangolo.com/) for fast scripting and automation  
-- ⚙️ Simple `.env`-based configuration for flexible environment switching  
-- 🔁 Seamless integration with the [Eclipse BaSyx](https://www.eclipse.org/basyx/) Environment REST API  
+```bash
+pip install shellsmith
+```
 
-## 🚀 Installation
+For CLI and MCP server support, install with optional dependencies:
 
 ```bash
-pip install shellsmith
+pip install shellsmith[cli,mcp]
 ```
 
 **Requires**: Python 3.10+
 
-## 🧠 CLI Usage
+## Python API Usage
+
+You can also use `shellsmith` as a Python client library to interact with the BaSyx Environment REST API.
+
+```python
+import shellsmith
+
+# Fetch all AAS Shells
+shells = shellsmith.get_shells()
+
+# Fetch a specific Submodel
+submodel = shellsmith.get_submodel("https://example.com/submodels/my-submodel")
+
+# Read and update a Submodel Element's value
+value = shellsmith.get_submodel_element_value(submodel["id"], "temperature")
+shellsmith.patch_submodel_element_value(submodel["id"], "temperature", "42.0")
+```
+
+> ℹ️ `shell_id` and `submodel_id` are automatically base64-encoded unless you pass `encode=False`.
+
+➡️ Full Python API reference: [shellsmith.pages.dev/api](https://shellsmith.pages.dev/api)
+
+## CLI Usage
 
 Shellsmith provides a powerful command-line interface:
 
@@ -121,29 +142,15 @@ aas --help
 
 ➡️ Full CLI reference: [shellsmith.pages.dev/cli](https://shellsmith.pages.dev/cli)
 
-## 🐍 Python API Usage
+## MCP Integration
 
-You can also use `shellsmith` as a Python client library to interact with the BaSyx Environment REST API.
+Shellsmith provides a Model Context Protocol (MCP) server that enables AI assistants to interact with Asset Administration Shells. The server exposes 25+ tools for comprehensive AAS management through a standardized interface.
 
-```python
-import shellsmith
+Configure with Claude Desktop or other MCP clients to get AI-powered AAS operations.
 
-# Fetch all AAS Shells
-shells = shellsmith.get_shells()
-
-# Fetch a specific Submodel
-submodel = shellsmith.get_submodel("https://example.com/submodels/my-submodel")
-
-# Read and update a Submodel Element's value
-value = shellsmith.get_submodel_element_value(submodel["id"], "temperature")
-shellsmith.patch_submodel_element_value(submodel["id"], "temperature", "42.0")
-```
-
-> ℹ️ `shell_id` and `submodel_id` are automatically base64-encoded unless you pass `encode=False`.
-
-➡️ Full Python API reference: [shellsmith.pages.dev/api](https://shellsmith.pages.dev/api)
+➡️ Full MCP reference: [shellsmith.pages.dev/mcp](https://shellsmith.pages.dev/mcp)
 
-## 🔧 Configuration
+## Configuration
 
 The default AAS environment host is:
 
@@ -173,9 +180,9 @@ You can override it in several ways:
   shellsmith.get_shells(host="https://your-host:1234")
   ```
 
-> 💡 The `--host` CLI flag and `host=` Python argument **take precedence** over environment variables and `.env`.
+> ℹ️ The `--host` CLI flag and `host=` Python argument **take precedence** over environment variables and `.env`.
 
-## 🤝 Contributing
+## Contributing
 
 We welcome contributions!
 

{shellsmith-0.4.0 → shellsmith-0.5.0}/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <img src="https://raw.githubusercontent.com/SmartFactory-KL/shellsmith/main/docs/images/logo-purple-500.png" alt="shellsmith">
+    <img src="https://raw.githubusercontent.com/SmartFactory-KL/shellsmith/main/docs/images/banner-purple-500.png" alt="shellsmith">
 </div>
 
 <div align="center">
@@ -13,26 +13,45 @@
     <b>Documentation</b>: <a href="https://shellsmith.pages.dev/" target="_blank">https://shellsmith.pages.dev</a>
 </p>
 
-**Shellsmith** is a Python SDK and CLI for managing [Asset Administration Shells (AAS)](https://industrialdigitaltwin.org/en/content-hub/aasspecifications), Submodels, and Submodel Elements via the [Eclipse BaSyx](https://www.eclipse.org/basyx/) REST API.  
- 
-It provides full client-side access to AAS resources with a clean Python interface and a powerful `typer`-based CLI — ideal for scripting, automation, and digital twin integration workflows.
+**Shellsmith** is a Python SDK for managing [Asset Administration Shells (AAS)](https://industrialdigitaltwin.org/en/content-hub/aasspecifications) via the [Eclipse BaSyx](https://www.eclipse.org/basyx/) REST API.
 
-### Features
+## Installation
 
-- 🐍 **Python SDK** for full CRUD access to Shells, Submodels, and Submodel Elements  
-- ⚡ **CLI tool** powered by [Typer](https://typer.tiangolo.com/) for fast scripting and automation  
-- ⚙️ Simple `.env`-based configuration for flexible environment switching  
-- 🔁 Seamless integration with the [Eclipse BaSyx](https://www.eclipse.org/basyx/) Environment REST API  
+```bash
+pip install shellsmith
+```
 
-## 🚀 Installation
+For CLI and MCP server support, install with optional dependencies:
 
 ```bash
-pip install shellsmith
+pip install shellsmith[cli,mcp]
 ```
 
 **Requires**: Python 3.10+
 
-## 🧠 CLI Usage
+## Python API Usage
+
+You can also use `shellsmith` as a Python client library to interact with the BaSyx Environment REST API.
+
+```python
+import shellsmith
+
+# Fetch all AAS Shells
+shells = shellsmith.get_shells()
+
+# Fetch a specific Submodel
+submodel = shellsmith.get_submodel("https://example.com/submodels/my-submodel")
+
+# Read and update a Submodel Element's value
+value = shellsmith.get_submodel_element_value(submodel["id"], "temperature")
+shellsmith.patch_submodel_element_value(submodel["id"], "temperature", "42.0")
+```
+
+> ℹ️ `shell_id` and `submodel_id` are automatically base64-encoded unless you pass `encode=False`.
+
+➡️ Full Python API reference: [shellsmith.pages.dev/api](https://shellsmith.pages.dev/api)
+
+## CLI Usage
 
 Shellsmith provides a powerful command-line interface:
 
@@ -56,29 +75,15 @@ aas --help
 
 ➡️ Full CLI reference: [shellsmith.pages.dev/cli](https://shellsmith.pages.dev/cli)
 
-## 🐍 Python API Usage
+## MCP Integration
 
-You can also use `shellsmith` as a Python client library to interact with the BaSyx Environment REST API.
+Shellsmith provides a Model Context Protocol (MCP) server that enables AI assistants to interact with Asset Administration Shells. The server exposes 25+ tools for comprehensive AAS management through a standardized interface.
 
-```python
-import shellsmith
+Configure with Claude Desktop or other MCP clients to get AI-powered AAS operations.
 
-# Fetch all AAS Shells
-shells = shellsmith.get_shells()
-
-# Fetch a specific Submodel
-submodel = shellsmith.get_submodel("https://example.com/submodels/my-submodel")
-
-# Read and update a Submodel Element's value
-value = shellsmith.get_submodel_element_value(submodel["id"], "temperature")
-shellsmith.patch_submodel_element_value(submodel["id"], "temperature", "42.0")
-```
-
-> ℹ️ `shell_id` and `submodel_id` are automatically base64-encoded unless you pass `encode=False`.
-
-➡️ Full Python API reference: [shellsmith.pages.dev/api](https://shellsmith.pages.dev/api)
+➡️ Full MCP reference: [shellsmith.pages.dev/mcp](https://shellsmith.pages.dev/mcp)
 
-## 🔧 Configuration
+## Configuration
 
 The default AAS environment host is:
 
@@ -108,9 +113,9 @@ You can override it in several ways:
   shellsmith.get_shells(host="https://your-host:1234")
   ```
 
-> 💡 The `--host` CLI flag and `host=` Python argument **take precedence** over environment variables and `.env`.
+> ℹ️ The `--host` CLI flag and `host=` Python argument **take precedence** over environment variables and `.env`.
 
-## 🤝 Contributing
+## Contributing
 
 We welcome contributions!
 

{shellsmith-0.4.0 → shellsmith-0.5.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "shellsmith"
 dynamic = ["version"]
 authors = [{ name = "Peter Stein", email = "peter.stein@dfki.de" }]
-description = "A Python SDK and CLI for Eclipse BaSyx to manage Asset Administration Shells (AAS)"
+description = "A Python SDK for Eclipse BaSyx to manage Asset Administration Shells (AAS)"
 license = { file = "LICENSE" }
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"
@@ -31,17 +31,13 @@ keywords = [
     "industry40",
     "i40",
     "digital-twin",
-    "cli",
-    "typer",
     "rest-client",
     "python",
 ]
 dependencies = [
     "httpx",
     "pydantic-settings",
-    "fastmcp",
     "pyyaml",
-    "typer",
 ]
 
 [project.optional-dependencies]
@@ -55,19 +51,21 @@ test = [
     "types-pyyaml",
     "types-requests"
 ]
+cli = [
+    "aas-cli",
+]
 docs = [
     "mkdocs",
     "mkdocs-material",
     "termynal",
 ]
+mcp = [
+    "aas-mcp",
+]
 neo4j = [
     "neo4j",
 ]
 
-[project.scripts]
-aas = "shellsmith.cli.app:main"
-shellsmith-mcp = "shellsmith.mcp.server:cli_main"
-
 [project.urls]
 Homepage = "https://github.com/SmartFactory-KL/shellsmith"
 Issues = "https://github.com/SmartFactory-KL/shellsmith/issues"

shellsmith-0.4.0/src/shellsmith/cli/app.py

@@ -1,44 +0,0 @@
-"""Main CLI entry point for shellsmith with Typer."""
-
-import httpx
-import typer
-
-from .commands.decode import app as decode_app
-from .commands.encode import app as encode_app
-from .commands.groups.create import app as create_app
-from .commands.groups.delete import app as delete_app
-from .commands.groups.get import app as get_app
-from .commands.groups.update import app as update_app
-from .commands.info import app as info_app
-from .commands.nuke import app as nuke_app
-from .commands.upload import app as upload_app
-
-app = typer.Typer(
-    help="shellsmith - AAS Toolkit command-line interface.",
-    no_args_is_help=True,
-)
-
-app.add_typer(upload_app)
-app.add_typer(info_app)
-app.add_typer(nuke_app)
-app.add_typer(encode_app)
-app.add_typer(decode_app)
-app.add_typer(get_app)
-app.add_typer(delete_app)
-app.add_typer(update_app)
-app.add_typer(create_app)
-
-
-def main() -> None:
-    """Main entry point for the CLI."""
-    try:
-        app()
-    except httpx.ConnectError as e:
-        typer.secho(f"😩 {e}", fg=typer.colors.RED)
-    except Exception as e:
-        typer.secho(f"💥 Unexpected error: {e}", fg=typer.colors.RED)
-        raise
-
-
-if __name__ == "__main__":
-    main()

shellsmith-0.4.0/src/shellsmith/cli/args.py

@@ -1,30 +0,0 @@
-"""Reusable CLI arguments in commands."""
-
-import typer
-
-SHELL_ID: typer.Argument = typer.Argument(
-    ...,
-    help="The unique identifier of the Shell.",
-)
-
-SUBMODEL_ID: typer.Argument = typer.Argument(
-    ...,
-    help="The unique identifier of the Submodel.",
-)
-
-ID_SHORT_PATH: typer.Argument = typer.Argument(
-    ...,
-    help="The idShort path for the Submodel Element.",
-)
-
-OPTIONAL_ID_SHORT_PATH: typer.Argument = typer.Argument(
-    None,
-    help="Optional idShort path for a nested Submodel Element.",
-)
-
-AAS_PATH: typer.Argument = typer.Argument(
-    ...,
-    help="The path to the AAS file or folder to upload. Accepts: .json, .xml, .aasx",
-)
-
-VALUE: typer.Argument = typer.Argument(..., help="The new value as string.")

shellsmith-0.4.0/src/shellsmith/cli/commands/decode.py

@@ -1,13 +0,0 @@
-"""CLI command for base64-decoding unique identifiers."""
-
-import typer
-
-from shellsmith.utils import base64_decode
-
-app = typer.Typer()
-
-
-@app.command()
-def decode(value: str) -> None:
-    """Decodes a Base64 value."""
-    print(base64_decode(value))

shellsmith-0.4.0/src/shellsmith/cli/commands/encode.py

@@ -1,13 +0,0 @@
-"""CLI command for base64-encoding unique identifiers."""
-
-import typer
-
-from shellsmith.utils import base64_encode
-
-app = typer.Typer()
-
-
-@app.command("encode")
-def encode(value: str) -> None:
-    """Encodes a value to Base64."""
-    print(base64_encode(value))

shellsmith-0.4.0/src/shellsmith/cli/commands/groups/create.py

@@ -1,79 +0,0 @@
-"""CLI commands for creating Shells, Submodels, and Submodel Elements."""
-
-from pathlib import Path
-
-import typer
-
-from shellsmith import api
-from shellsmith.cli import args, opts
-from shellsmith.cli.handlers import handle_http_error
-from shellsmith.cli.pretty import make_label
-from shellsmith.cli.resolve import resolve_input
-
-app = typer.Typer(
-    name="create",
-    no_args_is_help=True,
-    help="Create Shells, Submodels and Submodel elements.",
-)
-
-
-@app.command("shell")
-@handle_http_error()
-def create_shell(
-    data: str | None = opts.DATA,
-    file: Path | None = opts.FILE,
-    host: str = opts.HOST,
-) -> None:
-    """🔹 Create a Shell from a data payload."""
-    payload = resolve_input(data, file)
-    created = api.create_shell(payload, host=host)
-    label = make_label(created)
-    typer.secho(f"✅ Created Shell: {label}", fg=typer.colors.GREEN)
-
-
-@app.command("submodel-ref")
-@handle_http_error()
-def create_submodel_ref(
-    shell_id: str = args.SHELL_ID,
-    data: str | None = opts.DATA,
-    file: Path | None = opts.FILE,
-    host: str = opts.HOST,
-) -> None:
-    """🔹 Create a Submodel reference for a Shell."""
-    payload = resolve_input(data, file)
-    api.create_submodel_ref(shell_id, payload, host=host)
-    message = f"✅ Created Submodel reference in Shell: {shell_id}"
-    typer.secho(message, fg=typer.colors.GREEN)
-
-
-@app.command("submodel")
-@handle_http_error()
-def create_submodel(
-    data: str | None = opts.DATA,
-    file: Path | None = opts.FILE,
-    host: str = opts.HOST,
-) -> None:
-    """🔸 Create a Submodel from a data payload."""
-    payload = resolve_input(data, file)
-    created = api.create_submodel(payload, host=host)
-    label = make_label(created)
-    typer.secho(f"✅ Created Submodel: {label}", fg=typer.colors.GREEN)
-
-
-@app.command("element")
-@handle_http_error()
-def create_element(
-    submodel_id: str = args.SUBMODEL_ID,
-    id_short_path: str | None = args.OPTIONAL_ID_SHORT_PATH,
-    data: str | None = opts.DATA,
-    file: Path | None = opts.FILE,
-    host: str = opts.HOST,
-) -> None:
-    """🔻 Create a Submodel Element (root or nested)."""
-    payload = resolve_input(data, file)
-    api.create_submodel_element(submodel_id, payload, id_short_path, host=host)
-    label = (
-        f"nested Element: {id_short_path}" if id_short_path else "root-level Element"
-    )
-    message = f"✅ Created {label} in Submodel: {submodel_id}"
-    typer.secho(message, fg=typer.colors.GREEN)

shellsmith-0.4.0/src/shellsmith/cli/commands/groups/delete.py

@@ -1,83 +0,0 @@
-"""CLI commands for deleting Shells, Submodels, and Submodel Elements."""
-
-import typer
-
-from shellsmith import api
-from shellsmith.cli import args, opts
-from shellsmith.cli.handlers import handle_http_error
-from shellsmith.cli.pretty import make_label
-from shellsmith.extract import collect_submodel_ids
-
-app = typer.Typer(
-    name="delete",
-    no_args_is_help=True,
-    help="Delete Shells, Submodels and Submodel elements.",
-)
-
-
-@app.command("shell")
-@handle_http_error()
-def delete_shell(
-    shell_id: str = args.SHELL_ID,
-    cascade: bool = opts.CASCADE,
-    host: str = opts.HOST,
-) -> None:
-    """🔹 Delete a Shell by ID, optionally with its referenced Submodels."""
-    if cascade:
-        shell = api.get_shell(shell_id, host=host)
-        submodel_ids = collect_submodel_ids(shell)
-
-        for submodel_id in submodel_ids:
-            api.delete_submodel(submodel_id, host=host)
-            message = f"✅ Deleted referenced Submodel: {submodel_id}"
-            typer.secho(message, fg=typer.colors.YELLOW)
-
-    api.delete_shell(shell_id, host=host)
-    typer.secho(f"✅ Deleted Shell: {shell_id}", fg=typer.colors.GREEN)
-
-
-@app.command("submodel-ref")
-@handle_http_error()
-def delete_submodel_ref(
-    shell_id: str = args.SHELL_ID,
-    submodel_id: str = args.SUBMODEL_ID,
-    host: str = opts.HOST,
-) -> None:
-    """🔹 Delete a Submodel reference from a Shell."""
-    api.delete_submodel_ref(shell_id, submodel_id, host=host)
-    message = f"✅ Deleted Submodel reference: {submodel_id} from Shell: {shell_id}"
-    typer.secho(message, fg=typer.colors.GREEN)
-
-
-@app.command("submodel")
-@handle_http_error()
-def delete_submodel(
-    submodel_id: str = args.SUBMODEL_ID,
-    remove_refs: bool = opts.REMOVE_REFS,
-    host: str = opts.HOST,
-) -> None:
-    """🔸 Delete a Submodel by ID."""
-    if remove_refs:
-        shells = api.get_shells(host=host)["result"]
-        for shell in shells:
-            if submodel_id in collect_submodel_ids(shell):
-                label = make_label(shell)
-                api.delete_submodel_ref(shell["id"], submodel_id)
-                message = f"🔗 Removed reference from Shell {label}"
-                typer.secho(message, fg=typer.colors.YELLOW)
-
-    api.delete_submodel(submodel_id, host=host)
-    message = f"✅ Deleted Submodel: {submodel_id}"
-    typer.secho(message, fg=typer.colors.GREEN)
-
-
-@app.command("element")
-def delete_element(
-    submodel_id: str = args.SUBMODEL_ID,
-    id_short_path: str = args.ID_SHORT_PATH,
-    host: str = opts.HOST,
-) -> None:
-    """🔻 Delete a Submodel Element by idShort path."""
-    api.delete_submodel_element(submodel_id, id_short_path, host=host)
-    message = f"✅ Deleted Element {id_short_path} from Submodel {submodel_id}"
-    typer.secho(message, fg=typer.colors.GREEN)