rndc-python 0.1.0__tar.gz

rndc_python-0.1.0/.gitignore

@@ -0,0 +1,216 @@
+# 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
+.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
+
+# 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 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

rndc_python-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 David Groves
+
+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.
+

rndc_python-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: rndc-python
+Version: 0.1.0
+Summary: Python client for ISC BIND's RNDC
+Project-URL: Homepage, https://github.com/davidgroves/rndc-python
+Project-URL: Repository, https://github.com/davidgroves/rndc-python
+Project-URL: Issues, https://github.com/davidgroves/rndc-python/issues
+Author-email: David Groves <dave@fibrecat.org>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bind,dns,named,rndc,tsig
+Classifier: Development Status :: 4 - Beta
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: Name Service (DNS)
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1.0
+Requires-Dist: dnspython>=2.6.1
+Requires-Dist: python-dotenv>=1.0.1
+Provides-Extra: dev
+Requires-Dist: pre-commit>=4.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Requires-Dist: ty>=0.0.3; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=6.0.0; extra == 'test'
+Requires-Dist: pytest-mock>=3.14.0; extra == 'test'
+Requires-Dist: pytest>=8.3.0; extra == 'test'
+Requires-Dist: testcontainers>=4.9.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# rndc-python
+
+Python client library for talking to ISC BIND's RNDC service.
+
+## Requirements
+
+- Python 3.10+
+
+## Installation
+
+```bash
+pip install rndc-python
+```
+
+Or using uv:
+
+```bash
+uv add rndc-python
+```
+
+### Command-line Interface
+
+The package includes a CLI tool `rndc-python-cli`:
+
+```bash
+# Using CLI options
+rndc-python-cli -s 127.0.0.1 -p 953 -a sha256 -k <base64-secret> status
+
+# Using environment variables
+export ZPAPI_RNDC_HOST=127.0.0.1
+export ZPAPI_RNDC_PORT=953
+export ZPAPI_RNDC_ALGORITHM=sha256
+export ZPAPI_RNDC_SECRET=<base64-secret>
+rndc-python-cli status
+
+# Mix of both (CLI options override env vars)
+rndc-python-cli --port 954 reload
+```
+
+## Configuration
+
+The client can read its settings from environment variables (or a `.env` file):
+
+- `ZPAPI_RNDC_HOST`
+- `ZPAPI_RNDC_PORT`
+- `ZPAPI_RNDC_ALGORITHM` (e.g. `hmac-sha256`)
+- `ZPAPI_RNDC_SECRET`
+- `ZPAPI_RNDC_TIMEOUT`
+- `ZPAPI_RNDC_MAX_RETRIES`
+- `ZPAPI_RNDC_RETRY_DELAY`
+
+You can also configure the client directly in Python:
+
+```python
+from rndc_python import RNDCClient, TSIGAlgorithm
+
+client = RNDCClient(
+    host="127.0.0.1",
+    port=953,
+    algorithm=TSIGAlgorithm.SHA256,
+    secret="your-base64-secret-here",
+    timeout=10,
+    max_retries=3,
+    retry_delay=2,
+)
+```
+
+All parameters are optional if you have configured environment variables or a `.env` file.
+
+## Usage
+
+### Python API
+
+```python
+from rndc_python import RNDCClient
+
+with RNDCClient() as rndc_client:
+    print(rndc_client.call("status"))
+```
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md) for development setup, building, and testing instructions.

rndc_python-0.1.0/README.md

@@ -0,0 +1,83 @@
+# rndc-python
+
+Python client library for talking to ISC BIND's RNDC service.
+
+## Requirements
+
+- Python 3.10+
+
+## Installation
+
+```bash
+pip install rndc-python
+```
+
+Or using uv:
+
+```bash
+uv add rndc-python
+```
+
+### Command-line Interface
+
+The package includes a CLI tool `rndc-python-cli`:
+
+```bash
+# Using CLI options
+rndc-python-cli -s 127.0.0.1 -p 953 -a sha256 -k <base64-secret> status
+
+# Using environment variables
+export ZPAPI_RNDC_HOST=127.0.0.1
+export ZPAPI_RNDC_PORT=953
+export ZPAPI_RNDC_ALGORITHM=sha256
+export ZPAPI_RNDC_SECRET=<base64-secret>
+rndc-python-cli status
+
+# Mix of both (CLI options override env vars)
+rndc-python-cli --port 954 reload
+```
+
+## Configuration
+
+The client can read its settings from environment variables (or a `.env` file):
+
+- `ZPAPI_RNDC_HOST`
+- `ZPAPI_RNDC_PORT`
+- `ZPAPI_RNDC_ALGORITHM` (e.g. `hmac-sha256`)
+- `ZPAPI_RNDC_SECRET`
+- `ZPAPI_RNDC_TIMEOUT`
+- `ZPAPI_RNDC_MAX_RETRIES`
+- `ZPAPI_RNDC_RETRY_DELAY`
+
+You can also configure the client directly in Python:
+
+```python
+from rndc_python import RNDCClient, TSIGAlgorithm
+
+client = RNDCClient(
+    host="127.0.0.1",
+    port=953,
+    algorithm=TSIGAlgorithm.SHA256,
+    secret="your-base64-secret-here",
+    timeout=10,
+    max_retries=3,
+    retry_delay=2,
+)
+```
+
+All parameters are optional if you have configured environment variables or a `.env` file.
+
+## Usage
+
+### Python API
+
+```python
+from rndc_python import RNDCClient
+
+with RNDCClient() as rndc_client:
+    print(rndc_client.call("status"))
+```
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md) for development setup, building, and testing instructions.

rndc_python-0.1.0/pyproject.toml

@@ -0,0 +1,123 @@
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "rndc-python"
+version = "0.1.0"
+description = "Python client for ISC BIND's RNDC"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [{ name = "David Groves", email = "dave@fibrecat.org" }]
+keywords = ["dns", "bind", "rndc", "tsig", "named"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "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",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14", 
+  "Topic :: Internet :: Name Service (DNS)",
+  "Topic :: System :: Systems Administration",
+  "Typing :: Typed",
+]
+dependencies = [
+  "click>=8.1.0",
+  "dnspython>=2.6.1",
+  "python-dotenv>=1.0.1",
+]
+
+[project.optional-dependencies]
+test = [
+  "pytest>=8.3.0",
+  "pytest-cov>=6.0.0",
+  "pytest-mock>=3.14.0",
+  "testcontainers>=4.9.0",
+]
+dev = [
+  "pre-commit>=4.0.0",
+  "ruff>=0.8.0",
+  "ty>=0.0.3",
+]
+
+[project.scripts]
+rndc-python-cli = "rndc_python.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/davidgroves/rndc-python"
+Repository = "https://github.com/davidgroves/rndc-python"
+Issues = "https://github.com/davidgroves/rndc-python/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/rndc_python"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/rndc_python",
+  "README.md",
+  "LICENSE",
+  "pyproject.toml",
+]
+
+[tool.uv]
+package = true
+
+[tool.pytest.ini_options]
+markers = [
+  "integration: marks tests as integration tests (require Docker)",
+]
+filterwarnings = [
+  "ignore::DeprecationWarning:testcontainers.core.waiting_utils",
+]
+addopts = "--cov=rndc_python --cov-report=term-missing"
+
+[tool.coverage.run]
+source = ["src/rndc_python"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+  "pragma: no cover",
+  "if __name__ == .__main__.:",
+  "raise NotImplementedError",
+]
+show_missing = true
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = [
+  "E",      # pycodestyle errors
+  "W",      # pycodestyle warnings
+  "F",      # Pyflakes
+  "I",      # isort
+  "B",      # flake8-bugbear
+  "C4",     # flake8-comprehensions
+  "UP",     # pyupgrade
+  "SIM",    # flake8-simplify
+]
+ignore = [
+  "E501",   # line too long (handled by formatter)
+  "SIM108", # ternary operator suggestion (less readable for long expressions)
+]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.ty.environment]
+python-version = "3.10"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.14.9",
+    "ty>=0.0.3",
+]

rndc_python-0.1.0/src/rndc_python/__init__.py

@@ -0,0 +1,36 @@
+"""
+rndc-python - A Python client library for ISC BIND's RNDC
+
+This library provides a Python interface to ISC BIND's Remote Name Daemon Control (RNDC).
+"""
+
+__version__ = "0.1.0"
+__author__ = "David Groves"
+__email__ = "dave@fibrecat.org"
+
+# Import main classes and enums
+
+from .enums import RNDCDataType, TSIGAlgorithm
+from .exceptions import (
+    RNDCAuthenticationError,
+    RNDCConnectionError,
+    RNDCError,
+    RNDCZoneAlreadyExistsError,
+    RNDCZoneNotFoundError,
+)
+from .rndc_client import RNDCClient
+from .rndc_config import RNDCConfig, rndc_config
+
+__all__ = [
+    "__version__",
+    "RNDCClient",
+    "TSIGAlgorithm",
+    "RNDCDataType",
+    "RNDCError",
+    "RNDCAuthenticationError",
+    "RNDCConnectionError",
+    "RNDCZoneNotFoundError",
+    "RNDCZoneAlreadyExistsError",
+    "RNDCConfig",
+    "rndc_config",
+]