| Name | vpn-server JSON |
| Version |
1.7.1
JSON |
| download |
| home_page | None |
| Summary | Create an on-demand VPN Server running OpenVPN using AWS EC2 |
| upload_time | 2024-05-27 02:12:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2021 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
openvpn-server
vpn-server
aws-ec2
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
###### Platform Supported
###### Repo Stats
[][LICENSE]
[][API_REPO]
[][API_REPO]
###### Deployments
[][gha_pages]
[][gha_pypi]
[][gha_markdown]
[](https://pypi.org/project/vpn-server/#files)
[](https://pypi.org/project/vpn-server)
[](https://libraries.io/pypi/vpn-server)
# VPN Server
Establish a scalable, on-demand VPN Server powered by OpenVPN on AWS EC2.
### Install
```shell
python -m pip install vpn-server
```
### Usage
```python
import vpn
# Instantiates the object
vpn_server = vpn.VPNServer()
# Create a VPN Server
vpn_server.create_vpn_server()
# Test an existing VPN Server
# vpn_server.test_vpn()
# Deletes the VPN Server
vpn_server.delete_vpn_server()
```
> :bulb: Please refer to the [wiki page](https://github.com/thevickypedia/vpn-server/wiki) for more usage instructions and payload requirements.
## Coding Standards
Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>
Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and
[`isort`](https://pycqa.github.io/isort/)
### [Release Notes](https://github.com/thevickypedia/vpn-server/blob/main/release_notes.rst)
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```
### Linting
`PreCommit` will ensure linting, and the doc creation are run on every commit.
**Requirement**
```shell
pip install sphinx==5.1.1 pre-commit recommonmark
```
**Usage**
```shell
pre-commit run --all-files
```
## Project Links
[Wiki](https://github.com/thevickypedia/vpn-server/wiki)
[Repository](https://github.com/thevickypedia/vpn-server)
[Runbook](https://thevickypedia.github.io/vpn-server/)
[Package](https://pypi.org/project/vpn-server/)
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][LICENSE]
[LICENSE]: https://github.com/thevickypedia/vpn-server/blob/main/LICENSE
[API_REPO]: https://api.github.com/repos/thevickypedia/vpn-server
[gha_pages]: https://github.com/thevickypedia/vpn-server/actions/workflows/pages/pages-build-deployment
[gha_pypi]: https://github.com/thevickypedia/vpn-server/actions/workflows/python-publish.yml
[gha_markdown]: https://github.com/thevickypedia/vpn-server/actions/workflows/markdown-validation.yml
Raw data
{
"_id": null,
"home_page": null,
"name": "vpn-server",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "openvpn-server, vpn-server, aws-ec2",
"author": null,
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": null,
"platform": null,
"description": "\n\n###### Platform Supported\n\n\n###### Repo Stats\n[][LICENSE]\n[][API_REPO]\n[][API_REPO]\n\n###### Deployments\n[][gha_pages]\n[][gha_pypi]\n[][gha_markdown]\n\n[](https://pypi.org/project/vpn-server/#files)\n[](https://pypi.org/project/vpn-server)\n[](https://libraries.io/pypi/vpn-server)\n\n# VPN Server\nEstablish a scalable, on-demand VPN Server powered by OpenVPN on AWS EC2.\n\n### Install\n```shell\npython -m pip install vpn-server\n```\n\n### Usage\n```python\nimport vpn\n\n# Instantiates the object\nvpn_server = vpn.VPNServer()\n\n# Create a VPN Server\nvpn_server.create_vpn_server()\n\n# Test an existing VPN Server\n# vpn_server.test_vpn()\n\n# Deletes the VPN Server\nvpn_server.delete_vpn_server()\n```\n\n> :bulb: Please refer to the [wiki page](https://github.com/thevickypedia/vpn-server/wiki) for more usage instructions and payload requirements.\n\n## Coding Standards\nDocstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>\nStyling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>\nClean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and\n[`isort`](https://pycqa.github.io/isort/)\n\n### [Release Notes](https://github.com/thevickypedia/vpn-server/blob/main/release_notes.rst)\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n### Linting\n`PreCommit` will ensure linting, and the doc creation are run on every commit.\n\n**Requirement**\n```shell\npip install sphinx==5.1.1 pre-commit recommonmark\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Project Links\n[Wiki](https://github.com/thevickypedia/vpn-server/wiki)\n\n[Repository](https://github.com/thevickypedia/vpn-server)\n\n[Runbook](https://thevickypedia.github.io/vpn-server/)\n\n[Package](https://pypi.org/project/vpn-server/)\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][LICENSE]\n\n[LICENSE]: https://github.com/thevickypedia/vpn-server/blob/main/LICENSE\n[API_REPO]: https://api.github.com/repos/thevickypedia/vpn-server\n[gha_pages]: https://github.com/thevickypedia/vpn-server/actions/workflows/pages/pages-build-deployment\n[gha_pypi]: https://github.com/thevickypedia/vpn-server/actions/workflows/python-publish.yml\n[gha_markdown]: https://github.com/thevickypedia/vpn-server/actions/workflows/markdown-validation.yml\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Create an on-demand VPN Server running OpenVPN using AWS EC2",
"version": "1.7.1",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/vpn-server/issues",
"Docs": "https://thevickypedia.github.io/vpn-server",
"Homepage": "https://github.com/thevickypedia/vpn-server",
"Release Notes": "https://github.com/thevickypedia/vpn-server/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/vpn-server"
},
"split_keywords": [
"openvpn-server",
" vpn-server",
" aws-ec2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf1f05da138933bf29263f47445a866c3814a9f3f8a720b037aeb83a7718cd54",
"md5": "ab6177338c4c246ac1e9b3cb93c47ccb",
"sha256": "734a4fcc5198cb8d7476f8d59e7b4f65daebed62f855caf62eba5d413f5bb94e"
},
"downloads": -1,
"filename": "vpn_server-1.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab6177338c4c246ac1e9b3cb93c47ccb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20003,
"upload_time": "2024-05-27T02:12:00",
"upload_time_iso_8601": "2024-05-27T02:12:00.089193Z",
"url": "https://files.pythonhosted.org/packages/bf/1f/05da138933bf29263f47445a866c3814a9f3f8a720b037aeb83a7718cd54/vpn_server-1.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-27 02:12:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "vpn-server",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vpn-server"
}
