acex-devkit 1.0.0__py3-none-any.whl

acex_devkit/__init__.py

@@ -0,0 +1,17 @@
+"""ACE-X DevKit - Development kit for building ACE-X drivers and plugins."""
+
+__version__ = "1.0.0"
+
+from acex_devkit.drivers import (
+    NetworkElementDriver,
+    TransportBase,
+    RendererBase,
+    ParserBase,
+)
+
+__all__ = [
+    "NetworkElementDriver",
+    "TransportBase",
+    "RendererBase",
+    "ParserBase",
+]

acex_devkit/drivers/__init__.py

@@ -0,0 +1,15 @@
+"""Base classes for ACE-X network element drivers."""
+
+from acex_devkit.drivers.base import (
+    NetworkElementDriver,
+    TransportBase,
+    RendererBase,
+    ParserBase,
+)
+
+__all__ = [
+    "NetworkElementDriver",
+    "TransportBase",
+    "RendererBase",
+    "ParserBase",
+]

acex_devkit/drivers/base.py

@@ -0,0 +1,123 @@
+"""Driver base classes for ACE-X network element drivers."""
+
+from abc import ABC, abstractmethod
+from typing import Any, Dict
+
+from acex_devkit.models.logical_node import LogicalNode
+
+
+class ParserBase(ABC):
+    """Base class for configuration parsers."""
+    
+    @abstractmethod
+    def parse(self, configuration: str) -> Any:
+        """Parse device configuration into a structured model.
+        
+        Args:
+            configuration: Raw configuration string from device
+            
+        Returns:
+            Parsed configuration model
+        """
+        pass
+
+
+class RendererBase(ABC):
+    """Base class for configuration renderers."""
+    
+    @abstractmethod
+    def render(self, model: Dict[str, Any], asset: Any = None) -> Any:
+        """Render configuration model to device-specific format.
+        
+        Args:
+            model: Device-agnostic configuration model
+            asset: Optional asset context
+            
+        Returns:
+            Device-specific configuration (e.g., string, XML tree)
+        """
+        pass
+
+
+class TransportBase(ABC):
+    """Base class for device transport/communication."""
+    
+    @abstractmethod
+    def connect(self) -> None:
+        """Establish connection to the device."""
+        pass
+
+    @abstractmethod
+    def send(self, payload: Any) -> None:
+        """Send configuration to the device.
+        
+        Args:
+            payload: Configuration payload to send
+        """
+        pass
+
+    @abstractmethod
+    def verify(self) -> bool:
+        """Verify configuration was applied correctly.
+        
+        Returns:
+            True if verification succeeded, False otherwise
+        """
+        pass
+
+    @abstractmethod
+    def rollback(self) -> None:
+        """Rollback configuration if verification fails."""
+        pass
+
+
+class NetworkElementDriver:
+    """Base class for network element drivers.
+    
+    Combines renderer, transport, and parser to provide complete
+    configuration management for network devices.
+    
+    Attributes:
+        renderer_class: Renderer class to use (must be set in subclass)
+        transport_class: Transport class to use (must be set in subclass)
+        parser_class: Parser class to use (must be set in subclass)
+    """
+    
+    renderer_class = None
+    transport_class = None
+    parser_class = None
+
+    def __init__(self):
+        """Initialize driver with renderer, transport, and parser instances."""
+        if self.renderer_class is None or self.transport_class is None or self.parser_class is None:
+            raise NotImplementedError(
+                "renderer_class, transport_class, and parser_class must be set in subclass"
+            )
+        self.renderer = self.renderer_class()
+        self.transport = self.transport_class()
+        self.parser = self.parser_class()
+
+    @abstractmethod
+    def render(self, logical_node: LogicalNode, asset: Any = None) -> Any:
+        """Render logical node to device configuration.
+        
+        Args:
+            logical_node: Logical node containing configuration
+            asset: Optional asset context
+            
+        Returns:
+            Rendered configuration
+        """
+        return self.renderer.render(logical_node.model_dump(), asset)
+
+    @abstractmethod
+    def parse(self, configuration: str) -> Any:
+        """Parse device configuration.
+        
+        Args:
+            configuration: Raw device configuration
+            
+        Returns:
+            Parsed configuration model
+        """
+        return self.parser.parse(configuration)

acex_devkit/drivers/base_driver.py

@@ -0,0 +1,53 @@
+from abc import ABC, abstractmethod
+from typing import Any, Dict
+
+class ParserBase(ABC):
+    @abstractmethod
+    def parse(self, model: Dict[str, Any]) -> Any:
+        """Parsar running-config"""
+
+class RendererBase(ABC):
+    @abstractmethod
+    def render(self, model: Dict[str, Any]) -> Any:
+        """Tar en device‑agnostisk konfigurationsmodell och returnerar
+        en transport‑specifik representation (t.ex. string, XML‑tree…)."""
+
+class TransportBase(ABC):
+    @abstractmethod
+    def connect(self) -> None: ...
+
+    @abstractmethod
+    def send(self, payload: Any) -> None: ...
+
+    @abstractmethod
+    def verify(self) -> bool: ...
+
+    @abstractmethod
+    def rollback(self) -> None: ...
+
+class NetworkElementDriver:
+    """Kombinerar renderer + transport – exponeras som en plugin."""
+    renderer_class = None
+    transport_class = None
+    parser_class = None
+
+    def __init__(self):
+        if self.renderer_class is None or self.transport_class is None or self.parser_class is None:
+            raise NotImplementedError("renderer_class and transport_class must be set in subclass")
+        self.renderer = self.renderer_class()
+        self.transport = self.transport_class()
+        self.parser = self.parser_class()
+
+    @abstractmethod
+    def render(self, logical_node: "LogicalNode") -> Any:
+        """Tar en LogicalNode och returnerar en konfigurationsrepresentation."""
+        return self.renderer.render(logical_node.model_dump())
+
+
+    # def apply(self, model: Dict[str, Any]) -> None:
+    #     cfg = self.renderer.render(model)
+    #     self.transport.connect()
+    #     self.transport.send(cfg)
+    #     if not self.transport.verify():
+    #         self.transport.rollback()
+    #         raise RuntimeError("Verification failed – rollback executed")

acex_devkit/exceptions/__init__.py

@@ -0,0 +1,41 @@
+"""Common exceptions for ACE-X DevKit."""
+
+
+class AcexDevkitException(Exception):
+    """Base exception for ACE-X DevKit."""
+    pass
+
+
+class MethodNotImplemented(AcexDevkitException):
+    """Raised when a required method is not implemented."""
+    pass
+
+
+class DriverException(AcexDevkitException):
+    """Base exception for driver-related errors."""
+    pass
+
+
+class ConnectionError(DriverException):
+    """Raised when device connection fails."""
+    pass
+
+
+class ConfigurationError(DriverException):
+    """Raised when configuration application fails."""
+    pass
+
+
+class VerificationError(DriverException):
+    """Raised when configuration verification fails."""
+    pass
+
+
+class RenderingError(DriverException):
+    """Raised when configuration rendering fails."""
+    pass
+
+
+class ParsingError(DriverException):
+    """Raised when configuration parsing fails."""
+    pass

acex_devkit/models/__init__.py

@@ -0,0 +1,7 @@
+"""Models for ACE-X DevKit."""
+
+# TODO: Move all models to this package
+# TODO: Move all base classes to this package
+
+
+__all__ = []

acex_devkit/types/__init__.py

@@ -0,0 +1,42 @@
+"""Type definitions and protocols for ACE-X DevKit."""
+
+from typing import Protocol, Any, Dict, runtime_checkable
+
+
+@runtime_checkable
+class Renderable(Protocol):
+    """Protocol for objects that can be rendered to configuration."""
+    
+    def render(self, model: Dict[str, Any], asset: Any = None) -> Any:
+        """Render configuration."""
+        ...
+
+
+@runtime_checkable
+class Parseable(Protocol):
+    """Protocol for objects that can parse configuration."""
+    
+    def parse(self, configuration: str) -> Any:
+        """Parse configuration."""
+        ...
+
+
+@runtime_checkable
+class Transportable(Protocol):
+    """Protocol for objects that can transport configuration."""
+    
+    def connect(self) -> None:
+        """Connect to device."""
+        ...
+    
+    def send(self, payload: Any) -> None:
+        """Send configuration."""
+        ...
+    
+    def verify(self) -> bool:
+        """Verify configuration."""
+        ...
+    
+    def rollback(self) -> None:
+        """Rollback configuration."""
+        ...

acex_devkit-1.0.0.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: acex-devkit
+Version: 1.0.0
+Summary: ACE-X DevKit - Development kit for building ACE-X drivers and plugins
+License: AGPL-3.0
+Keywords: automation,devkit,sdk,drivers,plugins
+Author: Johan Lahti
+Author-email: johan.lahti@acebit.se
+Requires-Python: >=3.13,<4.0
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pydantic (>=2.12.5,<3.0.0)
+Requires-Dist: typing-extensions (>=4.0.0,<5.0.0)
+Project-URL: Homepage, https://github.com/acex-labs/acex
+Project-URL: Repository, https://github.com/acex-labs/acex
+Description-Content-Type: text/markdown
+
+# ACE-X DevKit
+
+Development kit for building ACE-X drivers and plugins.
+
+## Installation
+
+```bash
+pip install acex-devkit
+```
+
+## Usage
+
+### Building a Network Element Driver
+
+```python
+from acex_devkit.drivers import NetworkElementDriver, TransportBase, RendererBase, ParserBase
+from acex_devkit.models import ComposedConfiguration
+
+class MyRenderer(RendererBase):
+    def render(self, model: dict) -> str:
+        # Implement your rendering logic
+        pass
+
+class MyTransport(TransportBase):
+    def connect(self) -> None:
+        # Implement connection logic
+        pass
+    
+    def send(self, payload: Any) -> None:
+        # Implement send logic
+        pass
+    
+    def verify(self) -> bool:
+        # Implement verification logic
+        return True
+    
+    def rollback(self) -> None:
+        # Implement rollback logic
+        pass
+
+class MyParser(ParserBase):
+    def parse(self, configuration: str) -> ComposedConfiguration:
+        # Implement parsing logic
+        pass
+
+class MyDriver(NetworkElementDriver):
+    renderer_class = MyRenderer
+    transport_class = MyTransport
+    parser_class = MyParser
+    
+    def render(self, configuration: ComposedConfiguration, asset):
+        return self.renderer.render(configuration, asset)
+    
+    def parse(self, configuration: str) -> ComposedConfiguration:
+        return self.parser.parse(configuration)
+```
+
+## Package Contents
+
+- **models**: Common data models (Asset, LogicalNode, ComposedConfiguration, etc.)
+- **drivers**: Base classes for building network element drivers
+- **exceptions**: Common exceptions
+- **types**: Type aliases and protocols
+
+## License
+
+AGPL-3.0
+

acex_devkit-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+acex_devkit/__init__.py,sha256=ANPGzAzDVEwQ24CvLvvg6pl3YH5K-Ce7PWWKtNDMOqc,318
+acex_devkit/drivers/__init__.py,sha256=dKTc3QNJu3x49nZaf53M95k524ODeK544B90PUl9y1I,277
+acex_devkit/drivers/base.py,sha256=njOEmzZ2glh6rNo9OHtwx7g-WL-vOVftc2akx1kMP2U,3557
+acex_devkit/drivers/base_driver.py,sha256=p4462s8CFeZxLIM9kSJfK5viaXfGg_k3s0MvRJMQYIA,1800
+acex_devkit/exceptions/__init__.py,sha256=KHfVL1rD1dTznMTO13t9bTsh32RdfzRilXovdXcXuLg,879
+acex_devkit/models/__init__.py,sha256=KsrEEDA5p2VrT2FZXxZyTaFckQcFge4o9d6S5ZRIYKs,133
+acex_devkit/types/__init__.py,sha256=4dgCg5YvI1GUUxliCgisIZWsOsXtSof0NtKmma8y6tM,1027
+acex_devkit-1.0.0.dist-info/METADATA,sha256=2Ox2V9e4pquO9lRBPrQSAQsaKLGA69rzn3vLYe9ozXE,2405
+acex_devkit-1.0.0.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+acex_devkit-1.0.0.dist-info/RECORD,,

acex_devkit-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.1
+Root-Is-Purelib: true
+Tag: py3-none-any