| Name | wg-federation JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | |
| Summary | A client/server tool to securely auto-registers peers to a wireguard VPN |
| upload_time | 2023-01-16 17:54:39 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | |
| keywords |
wireguard
vpn
federation
radius
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# wg-federation
A WireGuard federation server and client.
## Development
Python `virtualenv` must be installed on your system.
```bash
# Setup
python -m venv venv
source ./venv/bin/activate
pip install -e ".[dev]"
pip install -e ".[build]" # optional: if you want to build locally
wg-federation # To run wg-federation
# Deactivate
deactivate
```
### Run Unit Tests
```bash
pytest -v --spec
pytest -v --cov # To see coverage
```
### Run Functional Tests
```bash
behave tests/features
behave tests/features -w # To see all outputs of all features tagged @wip
```
### Run SAST Tests
```bash
bandit -c pyproject.toml -r -q .
```
### Setup IDE and Debugger
To avoid having to install the dependencies on your operating system, setup your IDE to use a python virtual environment “SDK”.
E.g. the `venv` directory you may have created above.
[Intellij/PyCharm provides this feature](https://www.jetbrains.com/help/idea/creating-virtual-environment.html).
This will allow the IDE to find the libraries in the virtual environment, run and debug the application.
To debug the application, run `src/wg_federation/__init__.py`
### Deploy Manually
#### Build
```bash
python -m build
```
#### Publish to Test PyPI
_Use `__token__` as a username to publish using a token_
```bash
twine upload --repository testpypi dist/*
```
#### Publish in Production (PyPI)
_Use `__token__` as a username to publish using a token_
```bash
twine upload dist/*VERSION_HERE
```
### Generate the Documentation
```bash
sphinx-apidoc -o doc/ src/wg_federation # Generate API documentation directly from the code
pyreverse -o png -d doc/img --colorized --ignore container.py,federation.py,wireguard_interface.py,hq_state.py,controller_events.py,hq_event.py,wireguard_peer.py,constants.py,main.py,status.py,raw_options.py,log_level.py,is_argument_data_class.py,is_data_class.py,interface_status.py,configuration_saver_interface.py,configuration_loader_interface.py,can_save_configuration_interface.py,can_load_configuration_interface.py,user_input.py,command_line_argument.py,configuration_backend.py,argparse_action.py,command_line_option.py src/wg_federation # Generate UML diagram
make -C doc html # Generate HTML documentation fr²om .rst source code
```
Raw data
{
"_id": null,
"home_page": "",
"name": "wg-federation",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Anuvu DevOps Team <MTL.DevOps.Team@globaleagle.com>",
"keywords": "wireguard,vpn,federation,radius",
"author": "",
"author_email": "Anuvu DevOps Team <MTL.DevOps.Team@globaleagle.com>",
"download_url": "https://files.pythonhosted.org/packages/c3/af/3d9ff443a67c4bb7884dbeb047434244f282f56cf3fbb2b6f6fb40546cb7/wg-federation-0.5.1.tar.gz",
"platform": null,
"description": "# wg-federation\n\nA WireGuard federation server and client.\n\n## Development\n\nPython `virtualenv` must be installed on your system.\n\n```bash\n# Setup\npython -m venv venv\nsource ./venv/bin/activate\npip install -e \".[dev]\"\npip install -e \".[build]\" # optional: if you want to build locally\nwg-federation # To run wg-federation\n\n# Deactivate\ndeactivate\n```\n\n### Run Unit Tests\n```bash\npytest -v --spec\npytest -v --cov # To see coverage\n```\n\n### Run Functional Tests\n\n```bash\nbehave tests/features\nbehave tests/features -w # To see all outputs of all features tagged @wip\n```\n\n### Run SAST Tests\n\n```bash\nbandit -c pyproject.toml -r -q .\n```\n\n### Setup IDE and Debugger\nTo avoid having to install the dependencies on your operating system, setup your IDE to use a python virtual environment \u201cSDK\u201d.\nE.g. the `venv` directory you may have created above.\n[Intellij/PyCharm provides this feature](https://www.jetbrains.com/help/idea/creating-virtual-environment.html).\nThis will allow the IDE to find the libraries in the virtual environment, run and debug the application.\n\nTo debug the application, run `src/wg_federation/__init__.py`\n\n### Deploy Manually\n\n#### Build\n```bash\npython -m build\n```\n\n#### Publish to Test PyPI\n_Use `__token__` as a username to publish using a token_\n```bash\ntwine upload --repository testpypi dist/*\n```\n\n#### Publish in Production (PyPI)\n_Use `__token__` as a username to publish using a token_\n```bash\ntwine upload dist/*VERSION_HERE\n```\n\n### Generate the Documentation\n\n```bash\nsphinx-apidoc -o doc/ src/wg_federation # Generate API documentation directly from the code\npyreverse -o png -d doc/img --colorized --ignore container.py,federation.py,wireguard_interface.py,hq_state.py,controller_events.py,hq_event.py,wireguard_peer.py,constants.py,main.py,status.py,raw_options.py,log_level.py,is_argument_data_class.py,is_data_class.py,interface_status.py,configuration_saver_interface.py,configuration_loader_interface.py,can_save_configuration_interface.py,can_load_configuration_interface.py,user_input.py,command_line_argument.py,configuration_backend.py,argparse_action.py,command_line_option.py src/wg_federation # Generate UML diagram\nmake -C doc html # Generate HTML documentation fr\u00b2om .rst source code\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A client/server tool to securely auto-registers peers to a wireguard VPN",
"version": "0.5.1",
"split_keywords": [
"wireguard",
"vpn",
"federation",
"radius"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1208f766b0d558b466682b8fbdc7390c809c1739f679eba8f2de38e9fc50408",
"md5": "be4e5ea05e75955f83de9415da3837cf",
"sha256": "1eb91852c9a93812f96d6dd817c066b0b082f9c5dbe9adc17a5e25f18e8ace86"
},
"downloads": -1,
"filename": "wg_federation-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be4e5ea05e75955f83de9415da3837cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 71920,
"upload_time": "2023-01-16T17:54:37",
"upload_time_iso_8601": "2023-01-16T17:54:37.828305Z",
"url": "https://files.pythonhosted.org/packages/a1/20/8f766b0d558b466682b8fbdc7390c809c1739f679eba8f2de38e9fc50408/wg_federation-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c3af3d9ff443a67c4bb7884dbeb047434244f282f56cf3fbb2b6f6fb40546cb7",
"md5": "f98e3c7b6b24e5dbcd62c9c719bf97bc",
"sha256": "87197206a5080838eba5476f0f7843a11a56991f9e28d5b4ecd1c4689448c07e"
},
"downloads": -1,
"filename": "wg-federation-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "f98e3c7b6b24e5dbcd62c9c719bf97bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 44956,
"upload_time": "2023-01-16T17:54:39",
"upload_time_iso_8601": "2023-01-16T17:54:39.558982Z",
"url": "https://files.pythonhosted.org/packages/c3/af/3d9ff443a67c4bb7884dbeb047434244f282f56cf3fbb2b6f6fb40546cb7/wg-federation-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-16 17:54:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "wg-federation"
}
