# The ngrok Agent SDK for Python
[![PyPI][pypi-badge]][pypi-url]
[![Supported Versions][ver-badge]][ver-url]
[![MIT licensed][mit-badge]][mit-url]
[![Apache-2.0 licensed][apache-badge]][apache-url]
[![Continuous integration][ci-badge]][ci-url]
[pypi-badge]: https://img.shields.io/pypi/v/ngrok
[pypi-url]: https://pypi.org/project/ngrok
[ver-badge]: https://img.shields.io/pypi/pyversions/ngrok.svg
[ver-url]: https://pypi.org/project/ngrok
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/ngrok/ngrok-rs/blob/main/LICENSE-MIT
[apache-badge]: https://img.shields.io/badge/license-Apache_2.0-blue.svg
[apache-url]: https://github.com/ngrok/ngrok-rs/blob/main/LICENSE-APACHE
[ci-badge]: https://github.com/ngrok/ngrok-py/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/ngrok/ngrok-py/actions/workflows/ci.yml
[Website](https://ngrok.com)
**Note: This is alpha-quality software. Interfaces are subject to change without warning.**
ngrok is a globally distributed reverse proxy commonly used for quickly getting a public URL to a
service running inside a private network, such as on your local laptop. The ngrok agent is usually
deployed inside a private network and is used to communicate with the ngrok cloud service.
This is the ngrok agent in library form, suitable for integrating directly into Python
applications. This allows you to quickly build ngrok into your application with no separate process
to manage.
If you're looking for the previous agent downloader project, it's over [here](https://github.com/OpenIoTHub/ngrok).
# Installation
The published library is available on
[PyPI](https://pypi.org/project/ngrok).
```shell
python -m pip install ngrok
```
ngrok-py officially supports Python 3.7+.
# Quickstart
After you've installed the package, you'll need an Auth Token. Retrieve one on the
[Auth Token page of your ngrok dashboard](https://dashboard.ngrok.com/get-started/your-authtoken)
There are multiple examples in [the /examples directory](https://github.com/ngrok/ngrok-py/tree/main/examples).
A minimal use-case looks like the following:
```python
async def create_tunnel():
builder = NgrokSessionBuilder()
session = await builder.authtoken_from_env().connect()
tunnel = await session.http_endpoint().metadata("python tun meta").listen()
print("tunnel: {}".format(tunnel.url()))
res = await tunnel.forward_tcp("localhost:9000")
```
# Platform Support
Pre-built binaries are provided on PyPI for the following platforms:
| OS | i686 | x64 | aarch64 | arm |
| ---------- | -----|-----|---------|-----|
| Windows | ✓ | ✓ | * | |
| MacOS | | ✓ | ✓ | |
| Linux | | ✓ | ✓ | ✓ |
| Linux musl | | ✓ | ✓ | |
| FreeBSD | | * | | |
ngrok-py, and [ngrok-rs](https://github.com/ngrok/ngrok-rs/) which it depends on, are open source, so it may be possible to build them for other platforms.
* Windows-aarch64 will be supported after the next release of [Ring](https://github.com/briansmith/ring/issues/1167).
* FreeBSD-x64 is built by the release process, but PyPI won't accept BSD flavors.
# Dependencies
This project relies on [PyO3](https://pyo3.rs/), an excellent system to ease development and building of Rust plugins for Python.
Thank you to [OpenIoTHub](https://github.com/OpenIoTHub/ngrok) for handing over the ngrok name on PyPI.
# License
This project is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in tokio-core by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
Raw data
{
"_id": null,
"home_page": null,
"name": "bobzillapypi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "ngrok,python,pypi,pyo3,ingress,networking",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6b/09/487349e72c41630e89a6554d3ffb9647d1743ec75b6f6692cf1c10dd2209/bobzillapypi-0.2.0.tar.gz",
"platform": null,
"description": "# The ngrok Agent SDK for Python\n\n[![PyPI][pypi-badge]][pypi-url]\n[![Supported Versions][ver-badge]][ver-url]\n[![MIT licensed][mit-badge]][mit-url]\n[![Apache-2.0 licensed][apache-badge]][apache-url]\n[![Continuous integration][ci-badge]][ci-url]\n\n[pypi-badge]: https://img.shields.io/pypi/v/ngrok\n[pypi-url]: https://pypi.org/project/ngrok\n[ver-badge]: https://img.shields.io/pypi/pyversions/ngrok.svg\n[ver-url]: https://pypi.org/project/ngrok\n[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg\n[mit-url]: https://github.com/ngrok/ngrok-rs/blob/main/LICENSE-MIT\n[apache-badge]: https://img.shields.io/badge/license-Apache_2.0-blue.svg\n[apache-url]: https://github.com/ngrok/ngrok-rs/blob/main/LICENSE-APACHE\n[ci-badge]: https://github.com/ngrok/ngrok-py/actions/workflows/ci.yml/badge.svg\n[ci-url]: https://github.com/ngrok/ngrok-py/actions/workflows/ci.yml\n\n[Website](https://ngrok.com)\n\n**Note: This is alpha-quality software. Interfaces are subject to change without warning.**\n\nngrok is a globally distributed reverse proxy commonly used for quickly getting a public URL to a\nservice running inside a private network, such as on your local laptop. The ngrok agent is usually\ndeployed inside a private network and is used to communicate with the ngrok cloud service.\n\nThis is the ngrok agent in library form, suitable for integrating directly into Python\napplications. This allows you to quickly build ngrok into your application with no separate process\nto manage.\n\nIf you're looking for the previous agent downloader project, it's over [here](https://github.com/OpenIoTHub/ngrok).\n\n# Installation\n\nThe published library is available on\n[PyPI](https://pypi.org/project/ngrok).\n\n```shell\npython -m pip install ngrok\n```\n\nngrok-py officially supports Python 3.7+.\n\n# Quickstart\n\nAfter you've installed the package, you'll need an Auth Token. Retrieve one on the\n[Auth Token page of your ngrok dashboard](https://dashboard.ngrok.com/get-started/your-authtoken)\n\nThere are multiple examples in [the /examples directory](https://github.com/ngrok/ngrok-py/tree/main/examples).\nA minimal use-case looks like the following:\n\n```python\nasync def create_tunnel():\n builder = NgrokSessionBuilder()\n session = await builder.authtoken_from_env().connect()\n tunnel = await session.http_endpoint().metadata(\"python tun meta\").listen()\n print(\"tunnel: {}\".format(tunnel.url()))\n\n res = await tunnel.forward_tcp(\"localhost:9000\")\n```\n\n# Platform Support\n\nPre-built binaries are provided on PyPI for the following platforms:\n\n| OS | i686 | x64 | aarch64 | arm |\n| ---------- | -----|-----|---------|-----|\n| Windows | \u2713 | \u2713 | * | |\n| MacOS | | \u2713 | \u2713 | |\n| Linux | | \u2713 | \u2713 | \u2713 |\n| Linux musl | | \u2713 | \u2713 | |\n| FreeBSD | | * | | |\n\nngrok-py, and [ngrok-rs](https://github.com/ngrok/ngrok-rs/) which it depends on, are open source, so it may be possible to build them for other platforms.\n\n* Windows-aarch64 will be supported after the next release of [Ring](https://github.com/briansmith/ring/issues/1167).\n* FreeBSD-x64 is built by the release process, but PyPI won't accept BSD flavors.\n\n# Dependencies\n\nThis project relies on [PyO3](https://pyo3.rs/), an excellent system to ease development and building of Rust plugins for Python.\n\nThank you to [OpenIoTHub](https://github.com/OpenIoTHub/ngrok) for handing over the ngrok name on PyPI.\n\n# License\n\nThis project is licensed under either of\n\n * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or\n http://www.apache.org/licenses/LICENSE-2.0)\n * MIT license ([LICENSE-MIT](LICENSE-MIT) or\n http://opensource.org/licenses/MIT)\n\nat your option.\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in tokio-core by you, as defined in the Apache-2.0 license, shall be\ndual licensed as above, without any additional terms or conditions.\n\n",
"bugtrack_url": null,
"license": "MIT OR Apache-2.0",
"summary": "The ngrok Agent SDK for Python",
"version": "0.2.0",
"split_keywords": [
"ngrok",
"python",
"pypi",
"pyo3",
"ingress",
"networking"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c2d1b0a03f7884fdf4a9acfdae48b1a579b0097ca073ed8701a820c08e9c8b94",
"md5": "d788f1a4d4055a09c13625e7a1eb03cc",
"sha256": "dc3ac4b24018fc67c4703c788103dea261fa08cc73cb385312d458dd0c6a9c56"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-macosx_10_7_x86_64.whl",
"has_sig": false,
"md5_digest": "d788f1a4d4055a09c13625e7a1eb03cc",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1687645,
"upload_time": "2023-03-10T18:40:18",
"upload_time_iso_8601": "2023-03-10T18:40:18.430172Z",
"url": "https://files.pythonhosted.org/packages/c2/d1/b0a03f7884fdf4a9acfdae48b1a579b0097ca073ed8701a820c08e9c8b94/bobzillapypi-0.2.0-cp37-abi3-macosx_10_7_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e4404690d16994cfabfa4fcd007f1452fe0b029d02db7e787196964cf91d7fe0",
"md5": "07ed21394daf03bbb5e95888b99ed16c",
"sha256": "eca3d7882ba8c7bbb2899d33353f25dfbaa718e63e9c21df4442c945278a54a0"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "07ed21394daf03bbb5e95888b99ed16c",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 3251746,
"upload_time": "2023-03-10T18:37:30",
"upload_time_iso_8601": "2023-03-10T18:37:30.629524Z",
"url": "https://files.pythonhosted.org/packages/e4/40/4690d16994cfabfa4fcd007f1452fe0b029d02db7e787196964cf91d7fe0/bobzillapypi-0.2.0-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "edbe4afeccb41ab57cdf0688bf1b5973c53e7618653be0900820757851d8fa28",
"md5": "174196c5d33c8f184d57f200876e1a2b",
"sha256": "d39cd55e8860c304af737b7b6172a5ab0c1bd9821647f73896ce899646515c0f"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "174196c5d33c8f184d57f200876e1a2b",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1572183,
"upload_time": "2023-03-10T18:34:31",
"upload_time_iso_8601": "2023-03-10T18:34:31.742279Z",
"url": "https://files.pythonhosted.org/packages/ed/be/4afeccb41ab57cdf0688bf1b5973c53e7618653be0900820757851d8fa28/bobzillapypi-0.2.0-cp37-abi3-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c54253cfb535032c9dfddd1328aafb2caa51f2f6145ea9ed03b5c05eb9f0d176",
"md5": "4d240058fc46e9919222538561a865f3",
"sha256": "7b7ec63a8e12596645ff2959e53ce8808a2a3348c5f131105c774e58092b6cc5"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "4d240058fc46e9919222538561a865f3",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1647051,
"upload_time": "2023-03-10T18:27:29",
"upload_time_iso_8601": "2023-03-10T18:27:29.620198Z",
"url": "https://files.pythonhosted.org/packages/c5/42/53cfb535032c9dfddd1328aafb2caa51f2f6145ea9ed03b5c05eb9f0d176/bobzillapypi-0.2.0-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6aea7d5444ba237e23a133ec93a234480dae388ebc4f2d357163bfa8bb6be9dd",
"md5": "1213d2891ec4f57c871a8cb86659100b",
"sha256": "5f91d8a13049cf93c57a2cf67b66ba5d4b48d46424cab574fe5805a4a98bc8b4"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"has_sig": false,
"md5_digest": "1213d2891ec4f57c871a8cb86659100b",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1506137,
"upload_time": "2023-03-10T18:29:31",
"upload_time_iso_8601": "2023-03-10T18:29:31.025028Z",
"url": "https://files.pythonhosted.org/packages/6a/ea/7d5444ba237e23a133ec93a234480dae388ebc4f2d357163bfa8bb6be9dd/bobzillapypi-0.2.0-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "438bd8a8fe4dcd570c994252eebc2d202a48e29b663c729b5292831f26a151e3",
"md5": "4b6ce3403597d27f65dda1224c21c14c",
"sha256": "939a3828f389fdc41f639627ae5c223e558080bd21578d71c1f782f942ef85cf"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "4b6ce3403597d27f65dda1224c21c14c",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1744748,
"upload_time": "2023-03-10T18:25:53",
"upload_time_iso_8601": "2023-03-10T18:25:53.601346Z",
"url": "https://files.pythonhosted.org/packages/43/8b/d8a8fe4dcd570c994252eebc2d202a48e29b663c729b5292831f26a151e3/bobzillapypi-0.2.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d35c0cbc578d5fad2334607dc578cd7de0f9eccf48d75e4947342e0c3eccb0ca",
"md5": "bab3184514e8b7749b9507d484958a1b",
"sha256": "b2ac2375cf28202bb313c6a7a51b4ae812de162fa77d3a777651adbbf56116c9"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-musllinux_1_2_aarch64.whl",
"has_sig": false,
"md5_digest": "bab3184514e8b7749b9507d484958a1b",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1800123,
"upload_time": "2023-03-10T18:26:38",
"upload_time_iso_8601": "2023-03-10T18:26:38.710459Z",
"url": "https://files.pythonhosted.org/packages/d3/5c/0cbc578d5fad2334607dc578cd7de0f9eccf48d75e4947342e0c3eccb0ca/bobzillapypi-0.2.0-cp37-abi3-musllinux_1_2_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ce0eb6be0f64891eaf2fa8ddec01b14c9ae7ee5ffe3e71790242f446938c281c",
"md5": "f4e8cdd7a84176839946ae74525c0ed8",
"sha256": "a1f692e5ee98a4fe64d00c20c52dbcc842943a3dd91644c68c54628f2dc8d103"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-musllinux_1_2_x86_64.whl",
"has_sig": false,
"md5_digest": "f4e8cdd7a84176839946ae74525c0ed8",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1776222,
"upload_time": "2023-03-10T18:27:35",
"upload_time_iso_8601": "2023-03-10T18:27:35.814360Z",
"url": "https://files.pythonhosted.org/packages/ce/0e/b6be0f64891eaf2fa8ddec01b14c9ae7ee5ffe3e71790242f446938c281c/bobzillapypi-0.2.0-cp37-abi3-musllinux_1_2_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "13fb62c98b63569922ec2f46b2353d09a76827fd0202286b6d10f10b9fcd5fde",
"md5": "b9ce06ac713003dc4726e678aa0fefd8",
"sha256": "6d42b06435b3d006d58afab2a6bc963e6ede16bcbfdf060536fe86fc4a652622"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-win32.whl",
"has_sig": false,
"md5_digest": "b9ce06ac713003dc4726e678aa0fefd8",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1630381,
"upload_time": "2023-03-10T18:31:13",
"upload_time_iso_8601": "2023-03-10T18:31:13.706838Z",
"url": "https://files.pythonhosted.org/packages/13/fb/62c98b63569922ec2f46b2353d09a76827fd0202286b6d10f10b9fcd5fde/bobzillapypi-0.2.0-cp37-abi3-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4601e19c52cdbedb304deb476820ff726171fa5a22705a0488803cf69a3f76cc",
"md5": "643f1749e3456bb10efd5c1c1a0043d4",
"sha256": "5d4303d270c1b41409c6ae7bfeccc62f58ab8aef7bfd11d5217c60c6aa83e26f"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0-cp37-abi3-win_amd64.whl",
"has_sig": false,
"md5_digest": "643f1749e3456bb10efd5c1c1a0043d4",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1832362,
"upload_time": "2023-03-10T18:29:23",
"upload_time_iso_8601": "2023-03-10T18:29:23.194927Z",
"url": "https://files.pythonhosted.org/packages/46/01/e19c52cdbedb304deb476820ff726171fa5a22705a0488803cf69a3f76cc/bobzillapypi-0.2.0-cp37-abi3-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6b09487349e72c41630e89a6554d3ffb9647d1743ec75b6f6692cf1c10dd2209",
"md5": "e466faf90640100211925e92160cc5fc",
"sha256": "abd8262716490baa19c39366b295dc22c375e3e01bd9ab88ed29bfffd6f8347b"
},
"downloads": -1,
"filename": "bobzillapypi-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e466faf90640100211925e92160cc5fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 38676,
"upload_time": "2023-03-10T18:25:54",
"upload_time_iso_8601": "2023-03-10T18:25:54.920789Z",
"url": "https://files.pythonhosted.org/packages/6b/09/487349e72c41630e89a6554d3ffb9647d1743ec75b6f6692cf1c10dd2209/bobzillapypi-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-10 18:25:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "bobzillapypi"
}
JSON