python3-cyberfusion-ferm-support 1.1.2.1__tar.gz

python3-cyberfusion-ferm-support-1.1.2.1/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.1
+Name: python3-cyberfusion-ferm-support
+Version: 1.1.2.1
+Summary: Library for ferm.
+Home-page: https://vcs.cyberfusion.nl/shared/python3-cyberfusion-ferm-support
+Author: Cyberfusion
+Author-email: support@cyberfusion.io
+Platform: linux
+Description-Content-Type: text/markdown
+
+# python3-cyberfusion-ferm-support
+
+Library for [ferm](http://ferm.foo-projects.org/).
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-ferm-support
+
+## Generic
+
+Run the following command to create a source distribution:
+
+    python3 setup.py sdist
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Example
+
+```python
+from cyberfusion.FermSupport.configuration import Configuration
+
+c = Configuration(path="/etc/ferm/vars.d/example.conf")
+
+c.add_variable(
+    name="EXAMPLE",
+    values=["2001:0db8::/32"]
+)
+
+c.save()
+```

python3-cyberfusion-ferm-support-1.1.2.1/README.md

@@ -0,0 +1,45 @@
+# python3-cyberfusion-ferm-support
+
+Library for [ferm](http://ferm.foo-projects.org/).
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-ferm-support
+
+## Generic
+
+Run the following command to create a source distribution:
+
+    python3 setup.py sdist
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Example
+
+```python
+from cyberfusion.FermSupport.configuration import Configuration
+
+c = Configuration(path="/etc/ferm/vars.d/example.conf")
+
+c.add_variable(
+    name="EXAMPLE",
+    values=["2001:0db8::/32"]
+)
+
+c.save()
+```

python3-cyberfusion-ferm-support-1.1.2.1/pyproject.toml

@@ -0,0 +1,21 @@
+[tool.isort]
+profile = "black"
+line_length = 79
+known_first_party = ["cyberfusion"]
+default_section = "THIRDPARTY"
+
+[tool.black]
+line-length = 79
+exclude = '''
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | venv
+  )/
+)
+'''

python3-cyberfusion-ferm-support-1.1.2.1/setup.cfg

@@ -0,0 +1,12 @@
+[aliases]
+test = pytest
+
+[tool:pytest]
+norecursedirs = .git build dist *.egg __pycache__ .cache
+testpaths = tests
+junit_suite_name = python3-cyberfusion-ferm-support
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

python3-cyberfusion-ferm-support-1.1.2.1/setup.py

@@ -0,0 +1,25 @@
+"""A setuptools based setup module."""
+
+from setuptools import setup
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="python3-cyberfusion-ferm-support",
+    version="1.1.2.1",
+    description="Library for ferm.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Cyberfusion",
+    author_email="support@cyberfusion.io",
+    url="https://vcs.cyberfusion.nl/shared/python3-cyberfusion-ferm-support",
+    platforms=["linux"],
+    packages=[
+        "cyberfusion.FermSupport",
+        "cyberfusion.FermSupport.configuration",
+        "cyberfusion.FermSupport.exceptions",
+    ],
+    package_dir={"": "src"},
+    data_files=[],
+)

python3-cyberfusion-ferm-support-1.1.2.1/src/cyberfusion/FermSupport/__init__.py

@@ -0,0 +1 @@
+"""Empty file to turn this into a package."""

python3-cyberfusion-ferm-support-1.1.2.1/src/cyberfusion/FermSupport/configuration/__init__.py

@@ -0,0 +1,80 @@
+"""Helpers for ferm configuration."""
+
+import os
+import subprocess
+from typing import List
+
+from cyberfusion.Common import find_executable
+from cyberfusion.FermSupport.configuration.custom_lines import CustomLine
+from cyberfusion.FermSupport.configuration.variables import (
+    Variable,
+    VariableValue,
+)
+from cyberfusion.FermSupport.exceptions import ConfigInvalidError
+from cyberfusion.SystemdSupport.units import Unit
+
+
+class Configuration:
+    """Represents configuration."""
+
+    def __init__(self, *, path: str) -> None:
+        """Set attributes."""
+        self.path = path
+
+        self.variables: List[Variable] = []
+        self.custom_lines: List[CustomLine] = []
+
+    def add_variable(self, *, name: str, values: List[str]) -> None:
+        """Add variable."""
+        self.variables.append(
+            Variable(
+                name=name,
+                values=[VariableValue(content=value) for value in values],
+            )
+        )
+
+    def add_custom_line(self, *, contents: str) -> None:
+        """Add custom line."""
+        self.custom_lines.append(CustomLine(contents=contents))
+
+    def __str__(self) -> str:
+        """Get string representation."""
+        return (
+            "\n".join(
+                [str(line) for line in self.variables + self.custom_lines]
+            )
+            + "\n"
+        )
+
+    @property
+    def is_valid(self) -> bool:
+        """Get if config is valid."""
+        try:
+            subprocess.run(
+                [find_executable("ferm"), "--noexec", self.path], check=True
+            )
+        except subprocess.CalledProcessError:
+            return False
+
+        return True
+
+    def save(self) -> bool:
+        """Get file object."""
+        if not os.path.exists(self.path):
+            with open(self.path, "w") as f:
+                pass
+
+        original_contents = open(self.path, "r").read()
+
+        with open(self.path, "w") as f:
+            f.write(str(self))
+
+        changed = original_contents != open(self.path, "r").read()
+
+        if changed:
+            if not self.is_valid:
+                raise ConfigInvalidError
+
+            Unit(f"ferm.{Unit.SUFFIX_SERVICE}").restart()
+
+        return changed

python3-cyberfusion-ferm-support-1.1.2.1/src/cyberfusion/FermSupport/configuration/custom_lines.py

@@ -0,0 +1,13 @@
+"""Helpers for ferm custom lines."""
+
+
+class CustomLine:
+    """Represents custom line."""
+
+    def __init__(self, *, contents: str) -> None:
+        """Set attributes."""
+        self.contents = contents
+
+    def __str__(self) -> str:
+        """Get string representation."""
+        return self.contents

python3-cyberfusion-ferm-support-1.1.2.1/src/cyberfusion/FermSupport/configuration/variables.py

@@ -0,0 +1,42 @@
+"""Helpers for ferm variables."""
+
+from typing import List
+
+
+class Variable:
+    """Represents variable."""
+
+    def __init__(self, *, name: str, values: List["VariableValue"]) -> None:
+        """Set attributes."""
+        self._name = name
+        self.values = values
+
+    @property
+    def name(self) -> str:
+        """Get name."""
+        return self._name.upper()
+
+    def __str__(self) -> str:
+        """Get string representation."""
+        lines = []
+
+        lines.append(f"@def ${self.name} = (")
+
+        for value in self.values:
+            lines.append("  " + str(value))
+
+        lines.append(");")
+
+        return "\n".join(lines)
+
+
+class VariableValue:
+    """Represents variable value."""
+
+    def __init__(self, *, content: str) -> None:
+        """Set attributes."""
+        self.content = content
+
+    def __str__(self) -> str:
+        """Get string representation."""
+        return self.content

python3-cyberfusion-ferm-support-1.1.2.1/src/cyberfusion/FermSupport/exceptions/__init__.py

@@ -0,0 +1,7 @@
+"""Exceptions."""
+
+
+class ConfigInvalidError(Exception):
+    """Config is invalid."""
+
+    pass

python3-cyberfusion-ferm-support-1.1.2.1/src/python3_cyberfusion_ferm_support.egg-info/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.1
+Name: python3-cyberfusion-ferm-support
+Version: 1.1.2.1
+Summary: Library for ferm.
+Home-page: https://vcs.cyberfusion.nl/shared/python3-cyberfusion-ferm-support
+Author: Cyberfusion
+Author-email: support@cyberfusion.io
+Platform: linux
+Description-Content-Type: text/markdown
+
+# python3-cyberfusion-ferm-support
+
+Library for [ferm](http://ferm.foo-projects.org/).
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-ferm-support
+
+## Generic
+
+Run the following command to create a source distribution:
+
+    python3 setup.py sdist
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Example
+
+```python
+from cyberfusion.FermSupport.configuration import Configuration
+
+c = Configuration(path="/etc/ferm/vars.d/example.conf")
+
+c.add_variable(
+    name="EXAMPLE",
+    values=["2001:0db8::/32"]
+)
+
+c.save()
+```

python3-cyberfusion-ferm-support-1.1.2.1/src/python3_cyberfusion_ferm_support.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+src/cyberfusion/FermSupport/__init__.py
+src/cyberfusion/FermSupport/configuration/__init__.py
+src/cyberfusion/FermSupport/configuration/custom_lines.py
+src/cyberfusion/FermSupport/configuration/variables.py
+src/cyberfusion/FermSupport/exceptions/__init__.py
+src/python3_cyberfusion_ferm_support.egg-info/PKG-INFO
+src/python3_cyberfusion_ferm_support.egg-info/SOURCES.txt
+src/python3_cyberfusion_ferm_support.egg-info/dependency_links.txt
+src/python3_cyberfusion_ferm_support.egg-info/top_level.txt

python3-cyberfusion-ferm-support-1.1.2.1/src/python3_cyberfusion_ferm_support.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

python3-cyberfusion-ferm-support-1.1.2.1/src/python3_cyberfusion_ferm_support.egg-info/top_level.txt

@@ -0,0 +1 @@
+cyberfusion