junoscfg 0.5.1__tar.gz

junoscfg-0.5.1/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: astral-sh/setup-uv@v4
+      - run: uv publish --trusted-publishing always

junoscfg-0.5.1/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.venv/
+.claude/
+tmp/
+site/
+run.sh
+data/xml-schema-from-device*.xml
+data/*.json
+data/*.yaml
+data/*.yaml_edit
+data/*.conf
+data/*.md
+data/*.schema

junoscfg-0.5.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 junoscfg contributors
+
+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.

junoscfg-0.5.1/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: junoscfg
+Version: 0.5.1
+Summary: Convert Junos configurations between XML, JSON, structured, and display set formats
+Project-URL: Homepage, https://github.com/dg-i/junoscfg
+Project-URL: Repository, https://github.com/dg-i/junoscfg
+Project-URL: Documentation, https://github.com/dg-i/junoscfg#readme
+Project-URL: Issues, https://github.com/dg-i/junoscfg/issues
+Author-email: Manon Goo <manon.goo@dg-i.net>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: anonymization,ansible,configuration,converter,json,juniper,junos,network,set,validation,xml,yaml
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: click>=8.0
+Requires-Dist: ipanon>=0.2.2
+Requires-Dist: jsonschema>=4.0
+Requires-Dist: lark>=1.1
+Requires-Dist: lxml>=4.9
+Requires-Dist: netutils>=1.17.1
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# Junoscfg (Python)
+
+Convert and validate Junos configurations between JSON, structured, YAML, and display set formats.
+
+Originally inspired by the [Ruby Junoser gem](https://github.com/codeout/junoser), now a comprehensive Junos configuration toolkit.
+
+## Installation
+
+```bash
+pip install junoscfg
+```
+
+## Usage
+
+### CLI
+
+```bash
+# Convert structured config to set commands
+junoscfg -i structured -e set config.conf
+
+# Convert JSON to set commands
+junoscfg -i json -e set config.json
+
+# Convert to structured format
+junoscfg -e structured config.set
+
+# Read from stdin
+echo '{"configuration":{"system":{"host-name":"test"}}}' | junoscfg -i json -e set
+
+# Transform YAML for Ansible (literal extraction)
+junoscfg edityaml ansibilize -p "addr:interfaces.interface[*].name" config.yaml
+
+# Offset mode for multi-router deployments (generates ipmath expressions)
+junoscfg edityaml ansibilize -P "addr:interfaces.interface[*].unit[*].family.*.address[*].name" config.yaml
+
+# Anonymize all sensitive data
+junoscfg -i json -e set --anonymize-all config.json
+
+# Anonymize with regex patterns (e.g. match site codes)
+junoscfg -e set --anonymize-sensitive-patterns 'LAX\d+' config.json
+
+# Retrieve XSD dump and generate schema artifacts
+echo "<rpc> <get-xnm-information> <type>xml-schema</type> <namespace>junos-configuration</namespace> </get-xnm-information> </rpc>" | ssh -Csp 830 router.example.com netconf > netconf.xml
+junoscfg schema generate netconf.xml -o ./artifacts/
+```
+
+### Python API
+
+```python
+from junoscfg import convert_config, Format, validate_json
+
+# Convert between any format pair
+result = convert_config(
+    '{"configuration":{"system":{"host-name":"test"}}}',
+    from_format=Format.JSON, to_format=Format.SET,
+)
+
+# Validate a JSON config
+result = validate_json('{"configuration":{"system":{"host-name":"test"}}}')
+print(result.valid)  # True
+
+# Convert with strict field-level validation (raises on invalid enum/pattern/IP values)
+result = convert_config(source, from_format=Format.JSON, to_format=Format.SET, strict=True)
+
+# Anonymize a configuration
+from junoscfg.anonymize import anonymize
+from junoscfg.anonymize.config import AnonymizeConfig
+
+config = AnonymizeConfig(ips=True, passwords=True, salt="my-salt")
+config.expand_all()
+ir = {"configuration": {"system": {"host-name": "router1", "name-server": [{"name": "8.8.8.8"}]}}}
+result = anonymize(ir, config)
+```
+
+## Documentation
+
+For full documentation, install the docs dependencies and run:
+
+```bash
+uv sync --group docs
+uv run mkdocs serve
+```
+
+Then open [http://127.0.0.1:8000](http://127.0.0.1:8000).
+
+Key sections:
+
+- **Getting Started** — Installation and usage examples
+- **User Guide** — Conversion, validation, and CLI reference
+- **API Reference** — Auto-generated Python API docs
+- **Architecture** — Design decisions and schema internals

junoscfg-0.5.1/README.md

@@ -0,0 +1,91 @@
+# Junoscfg (Python)
+
+Convert and validate Junos configurations between JSON, structured, YAML, and display set formats.
+
+Originally inspired by the [Ruby Junoser gem](https://github.com/codeout/junoser), now a comprehensive Junos configuration toolkit.
+
+## Installation
+
+```bash
+pip install junoscfg
+```
+
+## Usage
+
+### CLI
+
+```bash
+# Convert structured config to set commands
+junoscfg -i structured -e set config.conf
+
+# Convert JSON to set commands
+junoscfg -i json -e set config.json
+
+# Convert to structured format
+junoscfg -e structured config.set
+
+# Read from stdin
+echo '{"configuration":{"system":{"host-name":"test"}}}' | junoscfg -i json -e set
+
+# Transform YAML for Ansible (literal extraction)
+junoscfg edityaml ansibilize -p "addr:interfaces.interface[*].name" config.yaml
+
+# Offset mode for multi-router deployments (generates ipmath expressions)
+junoscfg edityaml ansibilize -P "addr:interfaces.interface[*].unit[*].family.*.address[*].name" config.yaml
+
+# Anonymize all sensitive data
+junoscfg -i json -e set --anonymize-all config.json
+
+# Anonymize with regex patterns (e.g. match site codes)
+junoscfg -e set --anonymize-sensitive-patterns 'LAX\d+' config.json
+
+# Retrieve XSD dump and generate schema artifacts
+echo "<rpc> <get-xnm-information> <type>xml-schema</type> <namespace>junos-configuration</namespace> </get-xnm-information> </rpc>" | ssh -Csp 830 router.example.com netconf > netconf.xml
+junoscfg schema generate netconf.xml -o ./artifacts/
+```
+
+### Python API
+
+```python
+from junoscfg import convert_config, Format, validate_json
+
+# Convert between any format pair
+result = convert_config(
+    '{"configuration":{"system":{"host-name":"test"}}}',
+    from_format=Format.JSON, to_format=Format.SET,
+)
+
+# Validate a JSON config
+result = validate_json('{"configuration":{"system":{"host-name":"test"}}}')
+print(result.valid)  # True
+
+# Convert with strict field-level validation (raises on invalid enum/pattern/IP values)
+result = convert_config(source, from_format=Format.JSON, to_format=Format.SET, strict=True)
+
+# Anonymize a configuration
+from junoscfg.anonymize import anonymize
+from junoscfg.anonymize.config import AnonymizeConfig
+
+config = AnonymizeConfig(ips=True, passwords=True, salt="my-salt")
+config.expand_all()
+ir = {"configuration": {"system": {"host-name": "router1", "name-server": [{"name": "8.8.8.8"}]}}}
+result = anonymize(ir, config)
+```
+
+## Documentation
+
+For full documentation, install the docs dependencies and run:
+
+```bash
+uv sync --group docs
+uv run mkdocs serve
+```
+
+Then open [http://127.0.0.1:8000](http://127.0.0.1:8000).
+
+Key sections:
+
+- **Getting Started** — Installation and usage examples
+- **User Guide** — Conversion, validation, and CLI reference
+- **API Reference** — Auto-generated Python API docs
+- **Architecture** — Design decisions and schema internals

junoscfg-0.5.1/private_test_data/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory except this .gitignore and the README
+*
+!.gitignore
+!README.md

junoscfg-0.5.1/private_test_data/README.md

@@ -0,0 +1,5 @@
+# Private Test Data
+
+Place private/real-world router configurations here for integration testing.
+All files in this directory (except this README) are gitignored.
+

junoscfg-0.5.1/pyproject.toml

@@ -0,0 +1,89 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "junoscfg"
+version = "0.5.1"
+description = "Convert Junos configurations between XML, JSON, structured, and display set formats"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Manon Goo", email = "manon.goo@dg-i.net" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: System Administrators",
+    "Intended Audience :: Telecommunications Industry",
+    "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",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: System :: Networking",
+    "Topic :: Utilities",
+    "Typing :: Typed",
+]
+keywords = ["junos", "juniper", "network", "configuration", "converter", "validation", "anonymization", "ansible", "set", "json", "xml", "yaml"]
+dependencies = [
+    "click>=8.0",
+    "lxml>=4.9",
+    "pyyaml>=6.0",
+    "jsonschema>=4.0",
+    "lark>=1.1",
+    "ipanon>=0.2.2",
+    "netutils>=1.17.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/dg-i/junoscfg"
+Repository = "https://github.com/dg-i/junoscfg"
+Documentation = "https://github.com/dg-i/junoscfg#readme"
+Issues = "https://github.com/dg-i/junoscfg/issues"
+
+[project.scripts]
+junoscfg = "junoscfg.cli:main"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "B", "A", "SIM", "TCH"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "CLAUDE.md",
+    ".claude/",
+    "mkdocs.yml",
+    "docs/",
+    "tests/",
+    "uv.lock",
+    "data/",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/junoscfg"]
+
+[dependency-groups]
+dev = [
+    "pytest>=7.0",
+    "ruff>=0.4",
+]
+docs = [
+    "mkdocs>=1.6",
+    "mkdocs-material>=9.5",
+    "mkdocstrings[python]>=0.25",
+]