Skip to main content

WireGuard Manager (wgm) is a command-line tool designed to simplify the management of WireGuard VPN users. It allows you to easily create, list, and delete WireGuard users with a few simple commands.

Project description

WireGuard Manager (wgm)

WireGuard Manager (wgm) is a command-line tool designed to simplify the management of WireGuard VPN users. It allows you to easily create, list, and delete WireGuard users with a few simple commands.

Installation

From Source

To install WireGuard Manager (wgm) from source, follow these steps:

  1. Clone the repository:

    git clone https://github.com/rlizana/wgm.git
    cd wgm
    
  2. Install the dependencies using Poetry:

    poetry install
    
  3. Install the package globally:

    poetry build
    pip install dist/*.whl
    

This will allow you to call wgm from anywhere in the console.

As a Package

To install WireGuard Manager (wgm) as a package, you can use pip:

pip install wgm

Usage

To use the WireGuard Manager, follow these steps:

  1. Activate the virtual environment:

    poetry shell
    
  2. Run the application:

    python main.py
    

Building the package

To build the package, follow these steps:

poetry build

Launch unit tests

To install the necessary dependencies for running unit tests with unittest, follow these steps:

Install the development dependencies: bash poetry install --with dev poetry run pre-commit install

Run the unit tests: bash python -m unittest discover tests

Or you can run the command

poetry run python -m wgm

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wgm-0.1.6.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wgm-0.1.6-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file wgm-0.1.6.tar.gz.

File metadata

  • Download URL: wgm-0.1.6.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.7 Linux/6.11.0-12-generic

File hashes

Hashes for wgm-0.1.6.tar.gz
Algorithm Hash digest
SHA256 3f2f76008516192aed67f9964388a2d62fba941b12755d7838a5e0e1bb3f5ca6
MD5 d00ad9f8d329497ac09d5654fecd520f
BLAKE2b-256 df55600ee121f58113bc2a691e4ba7ef2a26a3e43d7ee3244b9a1ccfc1b88a99

See more details on using hashes here.

File details

Details for the file wgm-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: wgm-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.7 Linux/6.11.0-12-generic

File hashes

Hashes for wgm-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 aad55f90cc18e73e74e96a6ba275cb93791bdf5fb6fd37be564bd1a3f3d34f41
MD5 71524c7cb1d31468ec2a383f6a871fc0
BLAKE2b-256 91cf3615f7b7f8b7b4eb93c3256939259e1c9bc64a190143f8a9a398a81fe310

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page