devaci 0.1.0__py3-none-any.whl

devaci/results.py

@@ -0,0 +1,71 @@
+"""Result data classes for devaci."""
+
+from __future__ import annotations
+
+import json
+from dataclasses import dataclass, field
+from datetime import datetime
+from typing import Any
+
+
+def _timestamp() -> str:
+    return datetime.now().strftime("%d/%m/%Y-%H:%M:%S")
+
+
+@dataclass(frozen=True)
+class Result:
+    """Base result shared by all devaci phases."""
+
+    success: bool = False
+    log: list[str] = field(default_factory=list)
+    date: str = field(default_factory=_timestamp)
+
+    def to_dict(self) -> dict[str, Any]:
+        return {"date": self.date, "success": self.success, "log": self.log}
+
+
+@dataclass(frozen=True)
+class JinjaResult(Result):
+    """Result of a Jinja template render."""
+
+    output: Any = None
+
+    def to_dict(self) -> dict[str, Any]:
+        data = super().to_dict()
+        data["output"] = self.output
+        return data
+
+
+@dataclass(frozen=True)
+class CobraResult(Result):
+    """Result of building the Cobra configuration."""
+
+    config: Any = None
+
+    @property
+    def xml(self) -> str | None:
+        return self.config.xmldata if self.config is not None else None
+
+    @property
+    def json(self) -> Any:
+        return json.loads(self.config.data) if self.config is not None else None
+
+    def to_dict(self) -> dict[str, Any]:
+        data = super().to_dict()
+        data["json"] = self.json
+        data["xml"] = self.xml
+        return data
+
+
+@dataclass(frozen=True)
+class DeployResult(Result):
+    """Result of deploying a single template."""
+
+    path: str = "/"
+    name: str = "template"
+
+    def to_dict(self) -> dict[str, Any]:
+        data = super().to_dict()
+        data["path"] = self.path
+        data["name"] = self.name
+        return data

devaci-0.1.0.dist-info/METADATA

@@ -0,0 +1,110 @@
+Metadata-Version: 2.5
+Name: devaci
+Version: 0.1.0
+Summary: Python library that generates Cisco ACI configuration and optionally pushes it to an APIC controller via Cisco's official Cobra SDK.
+Project-URL: Homepage, https://github.com/cocuni80/devaci
+Project-URL: Repository, https://github.com/cocuni80/devaci
+Project-URL: Issues, https://github.com/cocuni80/devaci/issues
+Author: Jorge Riveros
+License: MIT
+License-File: LICENSE
+Keywords: aci,apic,cisco,cobra,networking,sdn
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=15.0.0
+Description-Content-Type: text/markdown
+
+# devaci
+
+Python library that generates Cisco ACI configuration and optionally pushes it to an APIC controller via Cisco's official Cobra SDK.
+
+## Structure
+
+```
+devaci/
+├── LICENSE
+├── README.md
+├── pyproject.toml
+├── pyrightconfig.json
+├── uv.lock
+├── src/
+│   └── devaci/
+│       ├── __init__.py        # public API
+│       ├── console.py         # logging + rich console
+│       ├── data.py            # xlsx/csv loading and filtering
+│       ├── deploy.py          # DeployClass orchestrator
+│       ├── exceptions.py
+│       ├── filters.py         # Jinja filters + YAML loader
+│       ├── jinja.py           # JinjaRenderer
+│       ├── results.py         # result dataclasses
+│       └── cobra/
+│           ├── __init__.py    # CobraBuilder
+│           ├── base.py
+│           ├── builders.py    # registered ACI object handlers
+│           └── registry.py
+└── tests/
+    ├── test_cobra.py
+    ├── test_deploy.py
+    ├── test_devaci.py
+    └── test_outputs.py
+```
+
+## Installation (development)
+
+```bash
+pip install uv          # if you don't have it yet
+uv sync                 # creates .venv and installs devaci + dev dependencies
+source .venv/bin/activate
+```
+
+To add/remove dependencies:
+
+```bash
+uv add requests         # runtime dependency
+uv add --dev httpx      # development dependency
+uv remove requests
+```
+
+## External dependency: Cobra SDK
+
+The Cisco ACI Cobra SDK (`acicobra`, `acimodel`, `aciparser`, `acirpc`) is **not on PyPI**.
+Download the `.whl` files from Cisco and place them in the `vendor/` folder (not tracked by git), then:
+
+```bash
+uv pip install vendor/*.whl
+```
+
+Tests that depend on the Cobra SDK fail if it is not installed.
+
+## Tests
+
+```bash
+uv run pytest
+```
+
+## Lint and type checking
+
+```bash
+uv run ruff check .
+uv run mypy src
+```
+
+## Publishing
+
+```bash
+uv build
+uv publish
+```

devaci-0.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+devaci/__init__.py,sha256=rAi46Bunx6mSEM88fyEPrv4wet77VqLDJyQKZRPSLHQ,490
+devaci/console.py,sha256=NDRSGURaVLb42EhM4_wPbIotE1Jpx2a9ABVXwu0nTUg,1033
+devaci/data.py,sha256=i7a_Pr5merZ9-mw2spMmXNgzPdMkm61qNH1VMQscODc,2530
+devaci/deploy.py,sha256=tAVtf0UCY0ZGug_ouXWjkIZq9CSUpx_DbPFUTx7rVRM,12511
+devaci/exceptions.py,sha256=SJY7XpcXLLkNPPFYuEonFlT5zQQ6xjvQwBDn6EOvNnw,526
+devaci/filters.py,sha256=wSC1Yq1U0bmDPtxvYOuLqvapBDswyIDQGNScJwOeguE,3267
+devaci/jinja.py,sha256=5vtfE20oINgr1_CuM3zqFuaptCN_opnURGpqLiNfuos,1431
+devaci/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+devaci/results.py,sha256=Zs3QPECXYai3uSoDVPWUdr58L-CcS0cVOPrGhTjKgdc,1699
+devaci/cobra/__init__.py,sha256=JGHXamT9-zJrSnnVWVBixiLYhaDYtE-LquDkdQL53s8,2906
+devaci/cobra/base.py,sha256=dTq0awniJNe-4XAPRedlKH0GnVDC7FQ5fviXkkQeWD8,841
+devaci/cobra/builders.py,sha256=BYwX4lekKUG792ClAw4_rdSk7PkqGL88crcz1TqdoUU,87087
+devaci/cobra/registry.py,sha256=LKh9_sAyakHXo0URP4w5MSP_5UTDEpN06SFV8relmkQ,583
+devaci-0.1.0.dist-info/METADATA,sha256=Nu6qPOPbYyrSEao7dmUkstIV5OFOw2edLmAJm-HgCEk,3174
+devaci-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+devaci-0.1.0.dist-info/licenses/LICENSE,sha256=1sWD1nTI5nS9Jxj6UktuJAEx_OG73nk0tWJBSZx9Mz0,1070
+devaci-0.1.0.dist-info/RECORD,,

devaci-0.1.0.dist-info/WHEEL

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

devaci-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jorge Riveros
+
+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.