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.4.tar.gz (18.1 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.4-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wgm-0.1.4.tar.gz
  • Upload date:
  • Size: 18.1 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.4.tar.gz
Algorithm Hash digest
SHA256 1c958c18e56837bb7948e45441f11b6926f6b5aa1165a95084da5c89c6d45305
MD5 e8108c65fd5415570263931ade6c8e24
BLAKE2b-256 55821c1acc02d187fd5c45bb6a9088f3b8c59524e0a8c1472857f24a0aaf0f03

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgm-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 20.0 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 20b3537f752d36bd7bd7167c22dff67e4329e66241cfbec207bb1e360f962358
MD5 cbb585409202f39d672a08fb31cc8b90
BLAKE2b-256 6758b7623bb2431edc7f753589935bb8271a8e4e269cdb0fd49446a2ea16b809

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