procustodibus_agent 1.8.0__tar.gz

procustodibus_agent-1.8.0/.build.yml

@@ -0,0 +1,45 @@
+image: fedora/latest
+packages:
+- iproute # for tests
+- libnsl # for python 3.7
+- libxcrypt-compat # for python 3.7
+- uv
+sources:
+- https://git.sr.ht/~arx10/procustodibus-agent
+tasks:
+- sync: |
+    cd procustodibus-agent
+    uv python install
+    uv sync
+- lint: |
+    cd procustodibus-agent
+    uv run ruff check
+    uv run ruff format --diff
+- test: |
+    cd procustodibus-agent
+    uv run pytest --cov --cov-report term-missing
+- test_py37: |
+    cd procustodibus-agent
+    uv run --python 3.7 pytest
+- test_py38: |
+    cd procustodibus-agent
+    uv run --python 3.8 pytest
+- test_py39: |
+    cd procustodibus-agent
+    uv run --python 3.9 pytest
+- test_py310: |
+    cd procustodibus-agent
+    uv run --python 3.10 pytest
+- test_py311: |
+    cd procustodibus-agent
+    uv run --python 3.11 pytest
+- test_py312: |
+    cd procustodibus-agent
+    uv run --python 3.12 pytest
+- test_py313: |
+    cd procustodibus-agent
+    uv run --python 3.13 pytest
+triggers:
+- action: email
+  condition: always
+  to: dev@arcemtene.com

procustodibus_agent-1.8.0/.dockerignore

@@ -0,0 +1,8 @@
+/build/
+.*cache
+/.coverage
+/.git/
+/htmlcov/
+*.pyc
+/test*
+/.venv/

procustodibus_agent-1.8.0/.editorconfig

@@ -0,0 +1,26 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.cfg,toml]
+indent_size = 4
+
+[Makefile]
+indent_style = tab
+
+[*.py]
+indent_size = 4
+max_line_length = 88
+
+[*.rst]
+indent_size = 3

procustodibus_agent-1.8.0/.gitignore

@@ -0,0 +1,18 @@
+# setuptools build dir
+/build/
+# tool caches
+.*cache
+# pytest-cov data
+/.coverage
+# setuptools dist dir
+/dist/
+# setuptools build package info
+/*.egg-info/
+# local env settings
+/.env
+# pytest-cov report
+/htmlcov/
+# compiled python
+*.pyc
+# uv virtualenvs
+/.venv/

procustodibus_agent-1.8.0/.python-version

@@ -0,0 +1,7 @@
+3.7.9
+3.8.20
+3.9.21
+3.10.16
+3.11.11
+3.12.8
+3.13.1

procustodibus_agent-1.8.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2019-2025 Arcem Tene
+
+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.

procustodibus_agent-1.8.0/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.4
+Name: procustodibus_agent
+Version: 1.8.0
+Summary: Synchronizes your WireGuard settings with Pro Custodibus.
+Project-URL: Homepage, https://www.procustodibus.com/
+Project-URL: Changelog, https://docs.procustodibus.com/guide/agents/download/#changelog
+Project-URL: Documentation, https://docs.procustodibus.com/guide/agents/run/
+Project-URL: Source, https://git.sr.ht/~arx10/procustodibus-agent
+Project-URL: Tracker, https://todo.sr.ht/~arx10/procustodibus-agent
+Author-email: Arcem Tene <dev@arcemtene.com>
+License: The MIT License
+        
+        Copyright (c) 2019-2025 Arcem Tene
+        
+        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.
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+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 :: 3.13
+Classifier: Topic :: System :: Networking :: Monitoring
+Requires-Python: >=3.6.2
+Requires-Dist: dnspython~=2.2
+Requires-Dist: docopt-ng~=0.7
+Requires-Dist: inflection~=0.5
+Requires-Dist: pynacl~=1.5
+Requires-Dist: pywin32~=306.0; sys_platform == 'win32'
+Requires-Dist: requests~=2.27
+Requires-Dist: tabulate~=0.8
+Description-Content-Type: text/markdown
+
+Pro Custodibus Agent
+====================
+
+[Pro Custodibus](https://www.procustodibus.com/) is a service that makes [WireGuard](https://www.wireguard.com/) networks easy to deploy and manage. You run the Pro Custodibus agent on each WireGuard host you want to manage, and the agent monitors and synchronizes the hosts' WireGuard settings with the remote Pro Custodibus service.
+
+
+Installing
+----------
+
+Requires python 3.8 or newer and libsodium. Installer script can install requirements, plus the agent itself, on most linuxes, FreeBSD, OpenBSD, and macOS (if macOS has [Homebrew](https://brew.sh/)). Install from source like the following:
+```
+./install.sh --install
+```
+
+Or run it like the following to see more options:
+```
+./install.sh --help
+```
+
+See the [Installer Documentation](https://docs.procustodibus.com/guide/agents/install/) for full details (or to download the pre-built Windows installer).
+
+
+Docker
+------
+
+The [docker/wireguard.dockerfile](https://git.sr.ht/~arx10/procustodibus-agent/tree/main/item/docker/wireguard.dockerfile) is built weekly and pushed to the [docker.io/procustodibus/wireguard](https://hub.docker.com/r/procustodibus/wireguard) repository. It produces a base WireGuard image without the agent.
+
+The [docker/agent.dockerfile](https://git.sr.ht/~arx10/procustodibus-agent/tree/main/item/docker/agent.dockerfile) is built weekly and pushed to the [docker.io/procustodibus/agent](https://hub.docker.com/r/procustodibus/agent) repository. It produces a Docker image with WireGuard and the latest agent installed together.
+
+Run either image by placing your WireGuard or Pro Custodibus configuration files in a host directory like `/srv/containers/wireguard/conf`, and then running the image like the following:
+```
+docker run \
+    --cap-add NET_ADMIN \
+    --publish 51820:51820/udp \
+    --name wireguard \
+    --rm \
+    --volume /srv/containers/wireguard/conf:/etc/wireguard \
+    procustodibus/agent
+```
+
+See the [Container Documentation](https://docs.procustodibus.com/guide/agents/container/) for full details.
+
+
+Development
+-----------
+
+### Set up dev env
+
+Install [uv](https://docs.astral.sh/uv/), and from this project root run:
+```
+uv python install
+uv sync
+```
+
+### Dev tasks
+
+Run unit tests:
+```
+uv run pytest
+```
+
+Run unit tests in watch mode:
+```
+uv run ptw .
+```
+
+Run unit tests with coverage report:
+```
+uv run pytest --cov --cov-report term-missing
+```
+
+Run linter and auto-fix where possible:
+```
+uv run ruff check --fix
+```
+
+Run formatter:
+```
+uv run ruff format
+```
+
+Build and run docker dev image (with `*.conf` files in `/srv/containers/wireguard/conf`):
+```
+docker/dev.sh dev
+docker run \
+    --cap-add NET_ADMIN \
+    --publish 51820:51820/udp \
+    --name wireguard \
+    --rm \
+    --volume /srv/containers/wireguard/conf:/etc/wireguard \
+    procustodibus-agent:dev
+```
+
+Run all (docker-based) installer tests:
+```
+docker compose -f test_install/docker-compose.yml build --pull
+uv run pytest test_install
+```
+
+### Build Windows MSI
+
+Install [uv](https://docs.astral.sh/uv/), and from this project root run:
+```
+uv run --python 3.12 --group freeze cx_freeze_setup.py bdist_msi
+```
+
+The MSI package will be built as `dist\procustodibus_agent-x.x.x-win64.msi`.
+
+### Build Windows installer exe
+
+1. Install [uv](https://docs.astral.sh/uv/).
+
+2. Install [Inno Setup](https://jrsoftware.org/isdl.php).
+
+3. Build the Windows executables with cx_freeze:
+    ```
+    uv run --python 3.12 --group freeze cx_freeze_setup.py build_exe
+    ```
+
+4. Build the Windows installer with Inno Setup:
+    ```
+    "C:\Program Files (x86)\Inno Setup 6\ISCC.exe" installer\windows.iss
+    ```
+
+The installer will be built as `dist\ProCustodibusAgentInstaller.exe`.
+
+
+Contributing
+------------
+
+* [Code of Conduct](https://docs.procustodibus.com/community/conduct/)
+* [File a Bug](https://docs.procustodibus.com/guide/community/bugs/)
+* [Report a Vulnerability](https://docs.procustodibus.com/guide/community/vulns/)
+* [Submit a Patch](https://docs.procustodibus.com/guide/community/code/)
+
+
+Resources
+---------
+
+* Home page: https://www.procustodibus.com/
+* Documentation: https://docs.procustodibus.com/guide/agents/run/
+* Changelog: https://docs.procustodibus.com/guide/agents/download/#changelog
+* Issue tracker: https://todo.sr.ht/~arx10/procustodibus
+* Mailing list: https://lists.sr.ht/~arx10/procustodibus
+* Source code: https://git.sr.ht/~arx10/procustodibus-agent
+
+
+License
+-------
+
+[The MIT License](https://git.sr.ht/~arx10/procustodibus-agent/tree/main/LICENSE)

procustodibus_agent-1.8.0/README.md

@@ -0,0 +1,151 @@
+Pro Custodibus Agent
+====================
+
+[Pro Custodibus](https://www.procustodibus.com/) is a service that makes [WireGuard](https://www.wireguard.com/) networks easy to deploy and manage. You run the Pro Custodibus agent on each WireGuard host you want to manage, and the agent monitors and synchronizes the hosts' WireGuard settings with the remote Pro Custodibus service.
+
+
+Installing
+----------
+
+Requires python 3.8 or newer and libsodium. Installer script can install requirements, plus the agent itself, on most linuxes, FreeBSD, OpenBSD, and macOS (if macOS has [Homebrew](https://brew.sh/)). Install from source like the following:
+```
+./install.sh --install
+```
+
+Or run it like the following to see more options:
+```
+./install.sh --help
+```
+
+See the [Installer Documentation](https://docs.procustodibus.com/guide/agents/install/) for full details (or to download the pre-built Windows installer).
+
+
+Docker
+------
+
+The [docker/wireguard.dockerfile](https://git.sr.ht/~arx10/procustodibus-agent/tree/main/item/docker/wireguard.dockerfile) is built weekly and pushed to the [docker.io/procustodibus/wireguard](https://hub.docker.com/r/procustodibus/wireguard) repository. It produces a base WireGuard image without the agent.
+
+The [docker/agent.dockerfile](https://git.sr.ht/~arx10/procustodibus-agent/tree/main/item/docker/agent.dockerfile) is built weekly and pushed to the [docker.io/procustodibus/agent](https://hub.docker.com/r/procustodibus/agent) repository. It produces a Docker image with WireGuard and the latest agent installed together.
+
+Run either image by placing your WireGuard or Pro Custodibus configuration files in a host directory like `/srv/containers/wireguard/conf`, and then running the image like the following:
+```
+docker run \
+    --cap-add NET_ADMIN \
+    --publish 51820:51820/udp \
+    --name wireguard \
+    --rm \
+    --volume /srv/containers/wireguard/conf:/etc/wireguard \
+    procustodibus/agent
+```
+
+See the [Container Documentation](https://docs.procustodibus.com/guide/agents/container/) for full details.
+
+
+Development
+-----------
+
+### Set up dev env
+
+Install [uv](https://docs.astral.sh/uv/), and from this project root run:
+```
+uv python install
+uv sync
+```
+
+### Dev tasks
+
+Run unit tests:
+```
+uv run pytest
+```
+
+Run unit tests in watch mode:
+```
+uv run ptw .
+```
+
+Run unit tests with coverage report:
+```
+uv run pytest --cov --cov-report term-missing
+```
+
+Run linter and auto-fix where possible:
+```
+uv run ruff check --fix
+```
+
+Run formatter:
+```
+uv run ruff format
+```
+
+Build and run docker dev image (with `*.conf` files in `/srv/containers/wireguard/conf`):
+```
+docker/dev.sh dev
+docker run \
+    --cap-add NET_ADMIN \
+    --publish 51820:51820/udp \
+    --name wireguard \
+    --rm \
+    --volume /srv/containers/wireguard/conf:/etc/wireguard \
+    procustodibus-agent:dev
+```
+
+Run all (docker-based) installer tests:
+```
+docker compose -f test_install/docker-compose.yml build --pull
+uv run pytest test_install
+```
+
+### Build Windows MSI
+
+Install [uv](https://docs.astral.sh/uv/), and from this project root run:
+```
+uv run --python 3.12 --group freeze cx_freeze_setup.py bdist_msi
+```
+
+The MSI package will be built as `dist\procustodibus_agent-x.x.x-win64.msi`.
+
+### Build Windows installer exe
+
+1. Install [uv](https://docs.astral.sh/uv/).
+
+2. Install [Inno Setup](https://jrsoftware.org/isdl.php).
+
+3. Build the Windows executables with cx_freeze:
+    ```
+    uv run --python 3.12 --group freeze cx_freeze_setup.py build_exe
+    ```
+
+4. Build the Windows installer with Inno Setup:
+    ```
+    "C:\Program Files (x86)\Inno Setup 6\ISCC.exe" installer\windows.iss
+    ```
+
+The installer will be built as `dist\ProCustodibusAgentInstaller.exe`.
+
+
+Contributing
+------------
+
+* [Code of Conduct](https://docs.procustodibus.com/community/conduct/)
+* [File a Bug](https://docs.procustodibus.com/guide/community/bugs/)
+* [Report a Vulnerability](https://docs.procustodibus.com/guide/community/vulns/)
+* [Submit a Patch](https://docs.procustodibus.com/guide/community/code/)
+
+
+Resources
+---------
+
+* Home page: https://www.procustodibus.com/
+* Documentation: https://docs.procustodibus.com/guide/agents/run/
+* Changelog: https://docs.procustodibus.com/guide/agents/download/#changelog
+* Issue tracker: https://todo.sr.ht/~arx10/procustodibus
+* Mailing list: https://lists.sr.ht/~arx10/procustodibus
+* Source code: https://git.sr.ht/~arx10/procustodibus-agent
+
+
+License
+-------
+
+[The MIT License](https://git.sr.ht/~arx10/procustodibus-agent/tree/main/LICENSE)

procustodibus_agent-1.8.0/coveragerc

@@ -0,0 +1,7 @@
+[run]
+branch = True
+omit = */test/*
+source = procustodibus_agent
+
+[report]
+show_missing = True