| Name | wgm JSON |
| Version |
0.1.6
JSON |
| download |
| home_page | None |
| Summary | 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. |
| upload_time | 2024-12-15 19:11:56 |
| maintainer | None |
| docs_url | None |
| author | Roberto Lizana |
| requires_python | <4.0,>=3.12 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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:
```bash
git clone https://github.com/rlizana/wgm.git
cd wgm
```
2. Install the dependencies using Poetry:
```bash
poetry install
```
3. Install the package globally:
```bash
poetry build
pip install dist/*.whl
```
This will allow you to call [wgm](http://_vscodecontentref_/0) from anywhere in the console.
### As a Package
To install WireGuard Manager (wgm) as a package, you can use pip:
```bash
pip install wgm
```
## Usage
To use the WireGuard Manager, follow these steps:
1. Activate the virtual environment:
```bash
poetry shell
```
2. Run the application:
```bash
python main.py
```
## Building the package
To build the package, follow these steps:
```bash
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
```bash
poetry run python -m wgm
```
Raw data
{
"_id": null,
"home_page": null,
"name": "wgm",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Roberto Lizana",
"author_email": "rober.lizana@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/df/55/600ee121f58113bc2a691e4ba7ef2a26a3e43d7ee3244b9a1ccfc1b88a99/wgm-0.1.6.tar.gz",
"platform": null,
"description": "# WireGuard Manager (wgm)\n\nWireGuard 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.\n\n## Installation\n\n### From Source\n\nTo install WireGuard Manager (wgm) from source, follow these steps:\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/rlizana/wgm.git\n cd wgm\n ```\n\n2. Install the dependencies using Poetry:\n ```bash\n poetry install\n ```\n\n3. Install the package globally:\n ```bash\n poetry build\n pip install dist/*.whl\n ```\n\nThis will allow you to call [wgm](http://_vscodecontentref_/0) from anywhere in the console.\n\n### As a Package\n\nTo install WireGuard Manager (wgm) as a package, you can use pip:\n\n```bash\npip install wgm\n```\n\n## Usage\n\nTo use the WireGuard Manager, follow these steps:\n\n1. Activate the virtual environment:\n ```bash\n poetry shell\n ```\n\n2. Run the application:\n ```bash\n python main.py\n ```\n\n## Building the package\n\nTo build the package, follow these steps:\n```bash\npoetry build\n```\n\n## Launch unit tests\n\nTo install the necessary dependencies for running unit tests with `unittest`, follow these steps:\n\nInstall the development dependencies:\n ```bash\n poetry install --with dev\n poetry run pre-commit install\n ```\n\nRun the unit tests:\n ```bash\n python -m unittest discover tests\n ```\n\nOr you can run the command\n```bash\npoetry run python -m wgm\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "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.",
"version": "0.1.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91cf3615f7b7f8b7b4eb93c3256939259e1c9bc64a190143f8a9a398a81fe310",
"md5": "71524c7cb1d31468ec2a383f6a871fc0",
"sha256": "aad55f90cc18e73e74e96a6ba275cb93791bdf5fb6fd37be564bd1a3f3d34f41"
},
"downloads": -1,
"filename": "wgm-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71524c7cb1d31468ec2a383f6a871fc0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 20171,
"upload_time": "2024-12-15T19:11:54",
"upload_time_iso_8601": "2024-12-15T19:11:54.891948Z",
"url": "https://files.pythonhosted.org/packages/91/cf/3615f7b7f8b7b4eb93c3256939259e1c9bc64a190143f8a9a398a81fe310/wgm-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df55600ee121f58113bc2a691e4ba7ef2a26a3e43d7ee3244b9a1ccfc1b88a99",
"md5": "d00ad9f8d329497ac09d5654fecd520f",
"sha256": "3f2f76008516192aed67f9964388a2d62fba941b12755d7838a5e0e1bb3f5ca6"
},
"downloads": -1,
"filename": "wgm-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "d00ad9f8d329497ac09d5654fecd520f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 18222,
"upload_time": "2024-12-15T19:11:56",
"upload_time_iso_8601": "2024-12-15T19:11:56.013399Z",
"url": "https://files.pythonhosted.org/packages/df/55/600ee121f58113bc2a691e4ba7ef2a26a3e43d7ee3244b9a1ccfc1b88a99/wgm-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 19:11:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "wgm"
}
