devaci 0.1.0__tar.gz

devaci-0.1.0/.gitignore

@@ -0,0 +1,236 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Vendor binaries (Cisco ACI Cobra SDK wheels)
+vendor/
+
+# Local reminder: do not publish yet
+DO_NOT_PUBLISH.md
+
+# Sensitive test data (e.g. xlsx, csv) - not committed
+data/
+
+# Generated outputs (private ACI configuration) - not committed
+outputs/
+scripts/
+logs/
+logging.json
+tests/testing/
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

devaci-0.1.0/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.

devaci-0.1.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,81 @@
+# 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/pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "devaci"
+version = "0.1.0"
+description = "Python library that generates Cisco ACI configuration and optionally pushes it to an APIC controller via Cisco's official Cobra SDK."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [
+    { name = "Jorge Riveros" },
+]
+keywords = ["cisco", "aci", "apic", "cobra", "networking", "sdn"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Networking",
+]
+dependencies = [
+    # Note: the Cisco ACI Cobra SDK (acicobra, acimodel, aciparser, acirpc)
+    # is distributed as .whl/.egg by Cisco and is NOT on PyPI.
+    # Install it separately before using devaci.
+    "jinja2>=3.1.6",
+    "openpyxl>=3.1.5",
+    "pandas>=2.3.3",
+    "pyyaml>=6.0.3",
+    "rich>=15.0.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "ruff>=0.5",
+    "mypy>=1.10",
+    "types-pyyaml>=6.0.12.20260906",
+]
+
+[project.urls]
+Homepage = "https://github.com/cocuni80/devaci"
+Repository = "https://github.com/cocuni80/devaci"
+Issues = "https://github.com/cocuni80/devaci/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/devaci"]
+exclude = ["src/devaci/_legacy"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/devaci", "tests", "README.md", "LICENSE"]
+exclude = ["src/devaci/_legacy"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+exclude = ["src/devaci/_legacy"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "UP", "B", "SIM"]
+
+[tool.ruff.lint.per-file-ignores]
+# Cobra SDK convention uses PascalCase locals mirroring Mo class names,
+# and the legacy handlers use nested `if` guards (kept verbatim).
+"src/devaci/cobra/builders.py" = ["N806", "SIM102"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+files = ["src"]
+exclude = ["_legacy"]
+
+[[tool.mypy.overrides]]
+module = ["cobra", "cobra.*", "jinja2", "pandas"]
+ignore_missing_imports = true

devaci-0.1.0/src/devaci/__init__.py

@@ -0,0 +1,20 @@
+"""devaci - Generate and push Cisco ACI configuration via the Cobra SDK."""
+
+from devaci.cobra import CobraBuilder
+from devaci.deploy import DeployClass
+from devaci.exceptions import CobraError, DataError, DeployError, DevaciError, JinjaError
+from devaci.jinja import JinjaRenderer
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "CobraBuilder",
+    "DeployClass",
+    "JinjaRenderer",
+    "DevaciError",
+    "CobraError",
+    "JinjaError",
+    "DataError",
+    "DeployError",
+    "__version__",
+]

devaci-0.1.0/src/devaci/cobra/__init__.py

@@ -0,0 +1,93 @@
+"""Cobra model builder for devaci."""
+
+from __future__ import annotations
+
+import json
+from typing import Any, cast
+
+import cobra.mit.request
+import cobra.model.pol
+
+from devaci.cobra.registry import REGISTRY
+from devaci.console import logger
+from devaci.results import CobraResult
+
+
+class CobraBuilder:
+    """Build an ACI configuration (:class:`ConfigRequest`) from a rendered dict.
+
+    The dict's top-level keys map to registered handlers (see
+    :mod:`devaci.cobra.builders`). Each handler receives the builder and the
+    list of objects and is responsible for adding Mo instances to
+    :attr:`config`.
+    """
+
+    def __init__(self) -> None:
+        self._root = ""
+        self._uni = cobra.model.pol.Uni(self._root)
+        self.config = cobra.mit.request.ConfigRequest()
+        self.result: CobraResult | None = None
+
+    @property
+    def root(self) -> str:
+        """Return the ACI root (policy universe DN)."""
+        return self._root
+
+    @property
+    def uni(self) -> cobra.model.pol.Uni:
+        """Return the root ``pol.Uni`` managed object."""
+        return self._uni
+
+    @property
+    def xml(self) -> str | None:
+        """Return the rendered XML payload."""
+        return cast(str | None, self.config.xmldata)
+
+    @property
+    def json(self) -> Any:
+        """Return the rendered JSON payload as a dict."""
+        return json.loads(self.config.data)
+
+    def render(self, output: dict[str, Any]) -> CobraResult:
+        """Render ``output`` through the registered handlers.
+
+        Keys with empty values are skipped; unknown keys and handler errors
+        are logged and reported via the returned :class:`CobraResult`.
+        """
+        logs: list[str] = []
+        success = True
+
+        for key, value in output.items():
+            if value in (None, [], {}, ""):
+                continue
+
+            handler = REGISTRY.get(key)
+            if handler is None:
+                success = False
+                msg = f"[Cobra] -> [ConfigError]: Class {key} does not exist."
+                logger.warning(msg)
+                logs.append(msg)
+                continue
+
+            try:
+                handler(self, value)
+                msg = f"[Cobra]: Class {key} was rendered successfully."
+                logger.info(msg)
+                logs.append(msg)
+            except Exception as exc:
+                success = False
+                msg = f"[Cobra] -> [{type(exc).__name__}]: Class {key} failed: {exc}"
+                logger.error(msg)
+                logs.append(msg)
+
+        if not self.config.configMos:
+            success = False
+            msg = "[Cobra] -> [ConfigError]: No object was found in configuration."
+            logger.warning(msg)
+            logs.append(msg)
+
+        self.result = CobraResult(success=success, log=logs, config=self.config)
+        return self.result
+
+
+from devaci.cobra import builders  # noqa: E402, F401

devaci-0.1.0/src/devaci/cobra/base.py

@@ -0,0 +1,28 @@
+"""Shared helpers for Cobra object builders."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable, Mapping
+from math import isnan
+from typing import Any
+
+
+def not_nan_str(value: Mapping[str, Any], keys: Iterable[str]) -> bool:
+    """Return True when none of the given keys hold an invalid value.
+
+    A value is considered invalid when it is ``None``, an empty/whitespace
+    string, the string ``nan`` (case-insensitive), or a float NaN. Missing
+    keys are ignored.
+    """
+
+    def is_invalid(v: Any) -> bool:
+        if v is None:
+            return True
+        if isinstance(v, str):
+            v = v.strip()
+            return not v or v.lower() == "nan"
+        if isinstance(v, float):
+            return isnan(v)
+        return False
+
+    return not any(is_invalid(value[k]) for k in keys if k in value)