dynamicdns 0.1.0rc0__py3-none-any.whl

dynamicdns/__init__.py

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: 2025-present tr4nt0r <4445816+tr4nt0r@users.noreply.github.com>
+#
+# SPDX-License-Identifier: MIT
+
+from .providers import Provider, ProviderConf, providers
+from .updater import Updater
+
+__version__ = "0.1.0rc0"
+__all__ = [
+    "providers",
+    "Provider",
+    "ProviderConf",
+    "Updater",
+]

dynamicdns/const.py

@@ -0,0 +1,15 @@
+"""Constants."""
+
+from typing import Final
+
+CONF_HOSTS: Final = "hosts"
+CONF_HOST: Final = "host"
+CONF_TOKEN: Final = "token"
+CONF_USERNAME: Final = "username"
+CONF_PASSWORD: Final = "password"
+CONF_IP_ADDRESS: Final = "ip_address"
+CONF_IPV6_ADDRESS: Final = "ipv6_address"
+CONF_VERBOSE: Final = "verbose"
+CONF_TXT: Final = "txt"
+CONF_CLEAR: Final = "clear"
+CONF_DOMAIN: Final = "domain"

dynamicdns/providers.py

@@ -0,0 +1,107 @@
+"""List of dynamic DNS providers."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from enum import StrEnum
+from typing import Callable
+
+import voluptuous as vol
+from yarl import URL
+
+from .const import (
+    CONF_DOMAIN,
+    CONF_HOST,
+    CONF_IP_ADDRESS,
+    CONF_IPV6_ADDRESS,
+    CONF_PASSWORD,
+    CONF_TOKEN,
+    CONF_USERNAME,
+)
+
+
+class Provider(StrEnum):
+    """Dynamic DNS providers."""
+
+    DUCKDNS = "duckdns"
+    MYTHICBEASTS_IPV4 = "mythicbeasts_ipv4"
+    ANYDNS = "anydns"
+    FREEDNS = "freedns"
+    FREEDNS_IPV6 = "freedns_ipv6"
+
+
+@dataclass(frozen=True, kw_only=True)
+class ProviderConf:
+    """Dynamic DNS provider config."""
+
+    name: str
+    base_url: str
+    method: str = "GET"
+    params: dict[str, str] = field(default_factory=dict)
+    schema: vol.Schema
+    success_fn: Callable[[str], bool] | None = None
+
+    def render_url(self, data: dict[str, str]) -> URL:
+        """Render the provider URL with given data and remove unused query parameters."""
+
+        url = URL(self.base_url)
+        url = url.with_path(url.path.format(**data))
+        return url % {k: data[v] for k, v in self.params.items() if v in data}
+
+
+providers: dict[Provider, ProviderConf] = {
+    Provider.DUCKDNS: ProviderConf(
+        name="Duck DNS",
+        base_url="https://www.duckdns.org/update?verbose=true",
+        params={
+            "domains": CONF_HOST,
+            "token": CONF_TOKEN,
+            "ip": CONF_IP_ADDRESS,
+            "ipv6": CONF_IPV6_ADDRESS,
+        },
+        schema=vol.Schema(
+            {
+                vol.Required(CONF_HOST): str,
+                vol.Required(CONF_TOKEN): vol.All(str, vol.Length(min=36, max=36)),
+            }
+        ),
+        success_fn=lambda x: x.startswith("OK"),
+    ),
+    Provider.MYTHICBEASTS_IPV4: ProviderConf(
+        name="Mythic Beasts IPv4",
+        base_url="https://ipv4.api.mythic-beasts.com/dns/v2/dynamic/{domain}",
+        method="POST",
+        params={"username": CONF_USERNAME, "password": CONF_PASSWORD},
+        schema=vol.Schema(
+            {
+                vol.Required(CONF_DOMAIN): str,
+                vol.Required(CONF_USERNAME): str,
+                vol.Required(CONF_PASSWORD): str,
+            },
+        ),
+    ),
+    Provider.ANYDNS: ProviderConf(
+        name="AnyDNS.info",
+        base_url="https://anydns.info/update.php",
+        params={"host": CONF_HOST, "user": CONF_USERNAME, "password": CONF_PASSWORD},
+        schema=vol.Schema(
+            {
+                vol.Required(CONF_HOST): str,
+                vol.Required(CONF_USERNAME): str,
+                vol.Required(CONF_PASSWORD): str,
+            },
+        ),
+    ),
+    Provider.FREEDNS: ProviderConf(
+        name="FreeDNS IPv4",
+        base_url="https://sync.afraid.org/u/{token}/",
+        schema=vol.Schema({vol.Required(CONF_TOKEN): str}),
+        success_fn=lambda x: x.startswith(("Updated", "No IP change")),
+    ),
+    Provider.FREEDNS_IPV6: ProviderConf(
+        name="FreeDNS IPv6",
+        base_url="https://v6.sync.afraid.org/u/{token}",
+        schema=vol.Schema({vol.Required(CONF_TOKEN): str}),
+        success_fn=lambda x: x.startswith(("Updated", "No IP change")),
+    ),
+}

dynamicdns/updater.py

@@ -0,0 +1,37 @@
+"""Dynamic DNS updater."""
+
+from __future__ import annotations
+
+import logging
+
+from aiohttp import ClientSession
+
+from .providers import Provider, providers
+
+_LOGGER = logging.getLogger(__package__)
+
+
+class Updater:
+    """Dynamic DNS updater class."""
+
+    def __init__(
+        self,
+        provider: Provider,
+        data: dict[str, str],
+        session: ClientSession,
+    ) -> None:
+        """Initialize."""
+
+        self.session = session
+        self.method = providers[provider].method
+        self.url = providers[provider].render_url(data)
+        self.success = providers[provider].success_fn
+
+    async def update(self) -> bool:
+        """Update the dynamic DNS record."""
+
+        async with self.session.request(self.method, self.url) as res:
+            _LOGGER.debug(await res.text())
+            return (
+                self.success(await res.text()) if self.success is not None else res.ok
+            )

dynamicdns-0.1.0rc0.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: dynamicdns
+Version: 0.1.0rc0
+Summary: Collection of Dynamic DNS providers
+Project-URL: Documentation, https://github.com/tr4nt0r/dynamicdns#readme
+Project-URL: Issues, https://github.com/tr4nt0r/dynamicdns/issues
+Project-URL: Source, https://github.com/tr4nt0r/dynamicdns
+Author-email: tr4nt0r <4445816+tr4nt0r@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: aiohttp>=3.12
+Requires-Dist: voluptuous>=0.15
+Requires-Dist: yarl>=1.20
+Description-Content-Type: text/markdown
+
+# DynamicDNS
+
+[![PyPI - Version](https://img.shields.io/pypi/v/dynamicdns.svg)](https://pypi.org/project/dynamicdns)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dynamicdns.svg)](https://pypi.org/project/dynamicdns)
+
+-----
+
+## Table of Contents
+
+- [DynamicDNS](#dynamicdns)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [License](#license)
+
+## Installation
+
+```console
+pip install dynamicdns
+```
+
+## License
+
+`dynamicdns` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

dynamicdns-0.1.0rc0.dist-info/RECORD

@@ -0,0 +1,8 @@
+dynamicdns/__init__.py,sha256=PopiNykPYAFKuHkafW_Aw8_OM7jRc8tThVWwN2HolYo,318
+dynamicdns/const.py,sha256=9aOikA152muIBSyJPoYVa5d8bPwgCogfO28m7pacXXk,388
+dynamicdns/providers.py,sha256=ZG9O-CAHdyEpfUj5OOyU-X6fjU22NpGQiitERgrT3u4,3193
+dynamicdns/updater.py,sha256=kEHt-XUXRWYeZwQefdR2ncjD9Kdr0XQTRcjCMxR0NYc,929
+dynamicdns-0.1.0rc0.dist-info/METADATA,sha256=a9KKhMCt2k79m0uEbComFL_QuquXmlhDlUmeqO3udyw,1626
+dynamicdns-0.1.0rc0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dynamicdns-0.1.0rc0.dist-info/licenses/LICENSE.txt,sha256=mRjb1OkwCPh8OBwRrkNZ225tHQ_0eNkVpQjx_vyQx88,1115
+dynamicdns-0.1.0rc0.dist-info/RECORD,,

dynamicdns-0.1.0rc0.dist-info/WHEEL

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

dynamicdns-0.1.0rc0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025-present tr4nt0r <4445816+tr4nt0r@users.noreply.github.com>
+
+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.