shellsmith 0.4.0__tar.gz → 0.6.0__tar.gz

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

@@ -1,7 +1,7 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: shellsmith
-Version: 0.4.0
-Summary: A Python SDK and CLI for Eclipse BaSyx to manage Asset Administration Shells (AAS)
+Version: 0.6.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.6.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.6.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"
@@ -109,3 +107,6 @@ ignore = [
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
+
+[tool.ruff.lint.pylint]
+max-args = 6

shellsmith-0.6.0/src/shellsmith/auth.py

@@ -0,0 +1,202 @@
+"""Sync and async auth."""
+
+import time
+import typing
+from dataclasses import dataclass
+
+import httpx
+from httpx import Request, Response
+from typing_extensions import override
+
+from shellsmith.config import config
+
+
+@dataclass
+class UserAuthentication:
+    """Authentication data for user-based authentication.
+
+    Args:
+        username: Username used for authentication.
+        password: Password used for authentication.
+    """
+
+    username: str
+    password: str
+
+
+@dataclass
+class ClientAuthentication:
+    """Authentication data for client-based authentication.
+
+    Args:
+        client_id: The unique identifier of the client used for authentication.
+        client_secret: The secret associated with the client used for authentication.
+    """
+
+    client_id: str
+    client_secret: str
+
+
+class TokenProvider:
+    """Base class for token providers.
+
+    To implement a custom token provider scheme, subclass `TokenProvider`
+    and provide data.
+    """
+
+    def __init__(
+        self,
+        token_url: str,
+        data: dict[str, str],
+        timeout: float = config.timeout,
+    ) -> None:
+        """Initialize a token provider.
+
+        Args:
+            token_url: URL of the token endpoint.
+            data: Data required to request an access token,
+                including the grant type and authentication credentials.
+            timeout: Request timeout in seconds.
+        """
+        self._token_url = token_url
+        self._timeout = timeout
+
+        self._token = None
+        self._expires_at = 0
+
+        self._data = data
+
+    def _token_valid(self) -> bool:
+        """Return whether the current token exists and has not expired."""
+        return self._token and time.time() < self._expires_at
+
+    def _save_token(self, data: dict[str, typing.Any]) -> None:
+        """Save the access token and calculate its expiration time.
+
+        Args:
+            data: Token response containing ``access_token`` and optionally
+                ``expires_in`` in seconds.
+        """
+        self._token = data["access_token"]
+        self._expires_at = time.time() + data.get("expires_in", 3600)
+
+    def sync_get_token(self) -> str:
+        """Return a valid access token synchronously, refreshing it when necessary."""
+        if self._token_valid():
+            return self._token
+
+        with httpx.Client() as client:
+            response = client.post(
+                self._token_url, timeout=self._timeout, data=self._data
+            )
+            response.raise_for_status()
+            self._save_token(response.json())
+
+        return self._token
+
+    async def async_get_token(self) -> str:
+        """Return a valid access token asynchronously, refreshing it when necessary."""
+        if self._token_valid():
+            return self._token
+
+        async with httpx.AsyncClient() as client:
+            r = await client.post(
+                self._token_url, timeout=self._timeout, data=self._data
+            )
+            r.raise_for_status()
+            payload = r.json()
+
+        self._save_token(payload)
+        return self._token
+
+
+class PasswordTokenProvider(TokenProvider):
+    """Token provider using password grant type (see https://www.rfc-editor.org/info/rfc6749/#section-4.3)."""
+
+    def __init__(
+        self,
+        token_url: str,
+        user_authentication: UserAuthentication,
+        client_authentication: ClientAuthentication | None = None,
+        timeout: float = config.timeout,
+    ) -> None:
+        """Initialize a password token provider.
+
+        Args:
+            token_url: URL of the token endpoint.
+            user_authentication: Username and password.
+            client_authentication: Optional client identifier and client secret.
+            timeout: Request timeout in seconds.
+        """
+        _data = {
+            "username": user_authentication.username,
+            "password": user_authentication.password,
+            "grant_type": "password",
+        }
+
+        if client_authentication:
+            _data.update(
+                {
+                    "client_id": client_authentication.client_id,
+                    "client_secret": client_authentication.client_secret,
+                }
+            )
+
+        super().__init__(token_url=token_url, data=_data, timeout=timeout)
+
+
+class ClientCredentialsTokenProvider(TokenProvider):
+    """Token provider using client credentials grant type (see https://www.rfc-editor.org/info/rfc6749/#section-2.3)."""
+
+    def __init__(
+        self,
+        token_url: str,
+        client_authentication: ClientAuthentication,
+        timeout: float = config.timeout,
+    ) -> None:
+        """Initialize a client credentials token provider.
+
+        Args:
+            token_url: URL of the token endpoint.
+            client_authentication: Client identifier and client secret.
+            timeout: Request timeout in seconds.
+        """
+        super().__init__(
+            token_url=token_url,
+            data={
+                "client_id": client_authentication.client_id,
+                "client_secret": client_authentication.client_secret,
+                "grant_type": "client_credentials",
+            },
+            timeout=timeout,
+        )
+
+
+class Auth(httpx.Auth):
+    """Authentication handler that adds an access token to httpx.request."""
+
+    def __init__(self, token_provider: "TokenProvider") -> None:
+        """Initialize the authentication handler.
+
+        Args:
+            token_provider: Provider used to obtain an access token.
+        """
+        self.token_provider = token_provider
+
+    @override
+    def sync_auth_flow(
+        self, request: Request
+    ) -> typing.Generator[Request, Response, None]:
+        """Synchronously fetch a token and add it to the request header."""
+        token = self.token_provider.sync_get_token()
+        request.headers["Authorization"] = f"Bearer {token}"
+        yield request
+
+    @override
+    async def async_auth_flow(
+        self, request: Request
+    ) -> typing.Generator[Request, Response, None]:
+        """Asynchronously fetch a token and add it to the request header."""
+        token = await self.token_provider.async_get_token()
+        request.headers["Authorization"] = f"Bearer {token}"
+        yield request

{shellsmith-0.4.0 → shellsmith-0.6.0}/src/shellsmith/clients.py

@@ -9,6 +9,7 @@ from urllib.parse import quote
 import httpx
 from httpx import Response
 
+from shellsmith.auth import Auth
 from shellsmith.config import config
 from shellsmith.types import JSON
 from shellsmith.utils import base64_encoded
@@ -21,20 +22,23 @@ class AsyncClient:
         self,
         host: str = config.host,
         timeout: float = config.timeout,
+        auth: Auth | None = None,
     ) -> None:
         """Initialize async client.
 
         Args:
             host: Base URL of the AAS server. Defaults to configured host.
             timeout: Request timeout in seconds.
+            auth: Authentication configuration for requests.
         """
         self.host = host
         self.timeout = timeout
         self._client: httpx.AsyncClient | None = None
+        self._auth = auth
 
     async def __aenter__(self) -> "AsyncClient":
         """Enter async context manager."""
-        self._client = httpx.AsyncClient(timeout=self.timeout)
+        self._client = httpx.AsyncClient(timeout=self.timeout, auth=self._auth)
         return self
 
     async def __aexit__(
@@ -705,20 +709,23 @@ class Client:
         self,
         host: str = config.host,
         timeout: float = config.timeout,
+        auth: Auth | None = None,
     ) -> None:
         """Initialize sync client.
 
         Args:
             host: Base URL of the AAS server. Defaults to configured host.
             timeout: Request timeout in seconds.
+            auth: Authentication configuration for requests.
         """
         self.host = host
         self.timeout = timeout
         self._client: httpx.Client | None = None
+        self._auth = auth
 
     def __enter__(self) -> "Client":
         """Enter context manager."""
-        self._client = httpx.Client(timeout=self.timeout)
+        self._client = httpx.Client(timeout=self.timeout, auth=self._auth)
         return self
 
     def __exit__(

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))