| Name | nctl JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Fuses ngrok and CloudFront offering a fully automated solution. |
| upload_time | 2024-08-17 14:09:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 TheVickypedia 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 |
nctl
ngrok
cloudfront
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NCTL
Fuses ngrok and CloudFront offering a fully automated solution
![Python][label-pyversion]
**Platform Supported**
![Platform][label-platform]
**Deployments**
[![pages][label-actions-pages]][gha_pages]
[![pypi][label-actions-pypi]][gha_pypi]
[![markdown][label-actions-markdown]][gha_md_valid]
[![Pypi][label-pypi]][pypi]
[![Pypi-format][label-pypi-format]][pypi-files]
[![Pypi-status][label-pypi-status]][pypi]
## Kick off
**Recommendations**
- Install `python` [3.10] or [3.11]
- Use a dedicated [virtual environment]
**Install nctl**
```shell
python -m pip install nctl
```
**Initiate - IDE**
```python
import nctl
if __name__ == '__main__':
nctl.tunnel()
```
**Initiate - CLI**
```shell
nctl start
```
> Use `nctl --help` for usage instructions.
## Environment Variables
<details>
<summary><strong>Sourcing environment variables from an env file</strong></summary>
> _By default, `nctl` will look for a `.env` file in the current working directory._<br>
</details>
- **PORT** - Port number to expose using ngrok.
- **HOST** - Hostname of the server that has to be exposed.
<br><br>
- **NGROK_AUTH** - Auth token for ngrok.
- **NGROK_CONFIG** - Ngrok configuration filepath. Auto-created when auth token is specified.
<br><br>
- **AWS_PROFILE_NAME** - AWS profile name.
- **AWS_ACCESS_KEY_ID** - AWS access key ID.
- **AWS_SECRET_ACCESS_KEY** - AWS secret key.
- **AWS_REGION_NAME** - AWS region name.
- **DISTRIBUTION_ID** - Cloudfront distribution ID. Required to update an existing distribution.
- **DISTRIBUTION_CONFIG** - Cloudfront distribution config filepath. Required to create a new distribution.
<br><br>
- **DEBUG** - Boolean flag to enable debug level logging.
- **LOG** - Simple option to switch between `stdout` and `file` logging.
- **LOG_CONFIG** - Custom logging configuration. Accepts `.yaml`, `.json` and `.ini` filetypes.
## Coding Standards
Docstring format: [`Google`][google-docs] <br>
Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
## [Release Notes][release-notes]
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```
## Linting
`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
markdown files (including Wiki pages)
**Requirement**
```shell
python -m pip install sphinx==5.1.1 pre-commit recommonmark
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[![pypi-module][label-pypi-package]][pypi-repo]
[https://pypi.org/project/nctl/][pypi]
## Runbook
[![made-with-sphinx-doc][label-sphinx-doc]][sphinx]
[https://thevickypedia.github.io/nctl/][runbook]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[//]: # (Labels)
[label-actions-markdown]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml/badge.svg
[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-nctl-blue?style=for-the-badge&logo=Python
[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
[label-actions-pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment/badge.svg
[label-actions-pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml/badge.svg
[label-pypi]: https://img.shields.io/pypi/v/nctl
[label-pypi-format]: https://img.shields.io/pypi/format/nctl
[label-pypi-status]: https://img.shields.io/pypi/status/nctl
[3.10]: https://docs.python.org/3/whatsnew/3.10.html
[3.11]: https://docs.python.org/3/whatsnew/3.11.html
[virtual environment]: https://docs.python.org/3/tutorial/venv.html
[release-notes]: https://github.com/thevickypedia/nctl/blob/main/release_notes.rst
[gha_pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment
[gha_pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml
[gha_md_valid]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml
[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
[pep8]: https://www.python.org/dev/peps/pep-0008/
[isort]: https://pycqa.github.io/isort/
[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
[pypi]: https://pypi.org/project/nctl
[pypi-files]: https://pypi.org/project/nctl/#files
[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
[license]: https://github.com/thevickypedia/nctl/blob/main/LICENSE
[runbook]: https://thevickypedia.github.io/nctl/
Raw data
{
"_id": null,
"home_page": null,
"name": "nctl",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "nctl, ngrok, cloudfront",
"author": null,
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": null,
"platform": null,
"description": "# NCTL\nFuses ngrok and CloudFront offering a fully automated solution\n\n![Python][label-pyversion]\n\n**Platform Supported**\n\n![Platform][label-platform]\n\n**Deployments**\n\n[![pages][label-actions-pages]][gha_pages]\n[![pypi][label-actions-pypi]][gha_pypi]\n[![markdown][label-actions-markdown]][gha_md_valid]\n\n[![Pypi][label-pypi]][pypi]\n[![Pypi-format][label-pypi-format]][pypi-files]\n[![Pypi-status][label-pypi-status]][pypi]\n\n## Kick off\n\n**Recommendations**\n\n- Install `python` [3.10] or [3.11]\n- Use a dedicated [virtual environment]\n\n**Install nctl**\n```shell\npython -m pip install nctl\n```\n\n**Initiate - IDE**\n```python\nimport nctl\n\n\nif __name__ == '__main__':\n nctl.tunnel()\n```\n\n**Initiate - CLI**\n```shell\nnctl start\n```\n\n> Use `nctl --help` for usage instructions.\n\n## Environment Variables\n\n<details>\n<summary><strong>Sourcing environment variables from an env file</strong></summary>\n\n> _By default, `nctl` will look for a `.env` file in the current working directory._<br>\n\n</details>\n\n- **PORT** - Port number to expose using ngrok.\n- **HOST** - Hostname of the server that has to be exposed.\n<br><br>\n\n- **NGROK_AUTH** - Auth token for ngrok.\n- **NGROK_CONFIG** - Ngrok configuration filepath. Auto-created when auth token is specified.\n<br><br>\n\n- **AWS_PROFILE_NAME** - AWS profile name.\n- **AWS_ACCESS_KEY_ID** - AWS access key ID.\n- **AWS_SECRET_ACCESS_KEY** - AWS secret key.\n- **AWS_REGION_NAME** - AWS region name.\n- **DISTRIBUTION_ID** - Cloudfront distribution ID. Required to update an existing distribution.\n- **DISTRIBUTION_CONFIG** - Cloudfront distribution config filepath. Required to create a new distribution.\n<br><br>\n\n- **DEBUG** - Boolean flag to enable debug level logging.\n- **LOG** - Simple option to switch between `stdout` and `file` logging.\n- **LOG_CONFIG** - Custom logging configuration. Accepts `.yaml`, `.json` and `.ini` filetypes.\n\n## Coding Standards\nDocstring format: [`Google`][google-docs] <br>\nStyling conventions: [`PEP 8`][pep8] and [`isort`][isort]\n\n## [Release Notes][release-notes]\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`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL\nmarkdown files (including Wiki pages)\n\n**Requirement**\n```shell\npython -m pip install sphinx==5.1.1 pre-commit recommonmark\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[![pypi-module][label-pypi-package]][pypi-repo]\n\n[https://pypi.org/project/nctl/][pypi]\n\n## Runbook\n[![made-with-sphinx-doc][label-sphinx-doc]][sphinx]\n\n[https://thevickypedia.github.io/nctl/][runbook]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[//]: # (Labels)\n\n[label-actions-markdown]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml/badge.svg\n[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-nctl-blue?style=for-the-badge&logo=Python\n[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx\n[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue\n[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg\n[label-actions-pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment/badge.svg\n[label-actions-pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml/badge.svg\n[label-pypi]: https://img.shields.io/pypi/v/nctl\n[label-pypi-format]: https://img.shields.io/pypi/format/nctl\n[label-pypi-status]: https://img.shields.io/pypi/status/nctl\n\n[3.10]: https://docs.python.org/3/whatsnew/3.10.html\n[3.11]: https://docs.python.org/3/whatsnew/3.11.html\n[virtual environment]: https://docs.python.org/3/tutorial/venv.html\n[release-notes]: https://github.com/thevickypedia/nctl/blob/main/release_notes.rst\n[gha_pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment\n[gha_pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml\n[gha_md_valid]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml\n[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings\n[pep8]: https://www.python.org/dev/peps/pep-0008/\n[isort]: https://pycqa.github.io/isort/\n[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html\n[pypi]: https://pypi.org/project/nctl\n[pypi-files]: https://pypi.org/project/nctl/#files\n[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/\n[license]: https://github.com/thevickypedia/nctl/blob/main/LICENSE\n[runbook]: https://thevickypedia.github.io/nctl/\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 TheVickypedia 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": "Fuses ngrok and CloudFront offering a fully automated solution.",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/nctl/issues",
"Docs": "https://thevickypedia.github.io/nctl",
"Homepage": "https://github.com/thevickypedia/nctl",
"Release Notes": "https://github.com/thevickypedia/nctl/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/nctl"
},
"split_keywords": [
"nctl",
" ngrok",
" cloudfront"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c1df3fa8755a03b98d72c91d933900621a5ba23fe5e2f65adbe55db8575defb",
"md5": "3f53f12ef554f5411ceeb903555d4522",
"sha256": "e81306e731acdcbbf6cfadf521c83186decfa932156afc3d8d82e031c44eb08c"
},
"downloads": -1,
"filename": "nctl-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f53f12ef554f5411ceeb903555d4522",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13314,
"upload_time": "2024-08-17T14:09:27",
"upload_time_iso_8601": "2024-08-17T14:09:27.585064Z",
"url": "https://files.pythonhosted.org/packages/3c/1d/f3fa8755a03b98d72c91d933900621a5ba23fe5e2f65adbe55db8575defb/nctl-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-17 14:09:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "nctl",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "nctl"
}
