Package Health Score

75 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Active

Popularity

Small

GitHub Stars: 39.08K
Forks: 3.04K
Contributors: 400

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package procustodibus-agent, we found that it has been starred 39,077 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 14, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like procustodibus-agent is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 59
Open PR: 9
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of procustodibus-agent based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that procustodibus-agent demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 400
Funding: Yes

A good and healthy external contribution signal for procustodibus-agent project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like procustodibus-agent is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.6

Age: 3 years
Latest Release: 1 month ago
Dependencies: 0 Direct
Versions: 22
Maintainers: 1
Wheels: OS Independent

Readme

Pro Custodibus Agent

Pro Custodibus is a service that makes WireGuard 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). 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 for full details (or to download the pre-built Windows installer).

Docker

The docker/wireguard.dockerfile is built weekly and pushed to the docker.io/procustodibus/wireguard repository. It produces a base WireGuard image without the agent.

The docker/agent.dockerfile is built weekly and pushed to the docker.io/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 for full details.

Development

Set up dev env

Create a virtualenv with pyenv:

pyenv virtualenv 3.10.4 procustodibus-agent

Activate the virtualenv:

pyenv local procustodibus-agent 3.8.19 3.9.19 3.10.14 3.11.9 3.12.4

Install tox:
```
pip install tox
```

Install pre-commit and pre-push hooks:

tox -e pre-commit -- install
tox -e pre-commit -- install -t pre-push

Dev tasks

List all tox tasks you can run:

tox -av

Run unit tests in watch mode:

tox -e watch

Build and run docker dev image (with *.conf files in /srv/containers/wireguard/conf):

tox -e build
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
tox -e py310 -- test_install

Manually run pre-push hook on all version-controlled files:

tox -e pre-commit -- run -a --hook-stage push

Build Windows installer

Install Python.
Install Inno Setup.

Create a virtualenv:

python -m venv C:\venvs\procustodibus-agent

Activate the virtualenv:

C:\venvs\procustodibus-agent\Scripts\activate.bat

Install tox:
```
pip install tox
```
Build the Windows executables with cx_freeze:
```
tox -e build_exe
```

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

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

FAQs

What is procustodibus-agent?

Synchronizes your WireGuard settings with Pro Custodibus. Visit Snyk Advisor to see a full health score report for procustodibus-agent, including popularity, security, maintenance & community analysis.

Is procustodibus-agent popular?

The python package procustodibus-agent receives a total of 147 weekly downloads. As such, procustodibus-agent popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is procustodibus-agent well maintained?

We found that procustodibus-agent demonstrated a healthy version release cadence and project activity. It has a community of 400 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is procustodibus-agent safe to use?

While scanning the latest version of procustodibus-agent, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 12 November-2024, at 20:31 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

procustodibus-agent

Synchronizes your WireGuard settings with Pro Custodibus. For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Pro Custodibus Agent

Installing

Docker

Development

Set up dev env

Dev tasks

Build Windows installer

Contributing

Resources

License

FAQs

What is procustodibus-agent?

Is procustodibus-agent popular?

Is procustodibus-agent well maintained?

Is procustodibus-agent safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Pro Custodibus Agent

Installing

Docker

Development

Set up dev env

Dev tasks

Build Windows installer

Contributing

Resources

License

FAQs

What is procustodibus-agent?

Is procustodibus-agent popular?

Is procustodibus-agent well maintained?

Is procustodibus-agent safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues