mirror of
https://github.com/DarkSecDevelopers/HiddenEye-Legacy.git
synced 2024-03-22 21:12:55 +08:00
121 lines
6.0 KiB
Plaintext
121 lines
6.0 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: pyngrok
|
||
|
|
Version: 4.1.10
|
||
|
|
Summary: A Python wrapper for Ngrok.
|
||
|
|
Home-page: https://github.com/alexdlaird/pyngrok
|
||
|
|
Author: Alex Laird
|
||
|
|
Author-email: contact@alexlaird.com
|
||
|
|
License: MIT
|
||
|
|
Download-URL: https://github.com/alexdlaird/pyngrok/archive/4.1.10.tar.gz
|
||
|
|
Project-URL: Documentation, https://pyngrok.readthedocs.io
|
||
|
|
Project-URL: Changelog, https://github.com/alexdlaird/pyngrok/blob/master/CHANGELOG.md
|
||
|
|
Project-URL: Sponsor, https://www.paypal.me/alexdlaird
|
||
|
|
Description: # pyngrok - a Python wrapper for ngrok [](https://twitter.com/intent/tweet?text=Unleash+the+power+of+ngrok%2C+programmatically+tunneling+to+localhost%2C+in+your+Python+applications+with+pyngrok.&url=https://github.com/alexdlaird/pyngrok&via=alexdlaird&hashtags=ngrok,tunnel,webhook,localhost,pyngrok)
|
||
|
|
|
||
|
|
[](https://badge.fury.io/py/pyngrok)
|
||
|
|
[](https://travis-ci.org/alexdlaird/pyngrok)
|
||
|
|
[](https://codecov.io/gh/alexdlaird/pyngrok)
|
||
|
|
[](https://pyngrok.readthedocs.io/en/latest/?badge=latest)
|
||
|
|
[](https://pypi.org/project/pyngrok/)
|
||
|
|
[](https://pypi.org/project/pyngrok/)
|
||
|
|
|
||
|
|
`pyngrok` is a Python wrapper for `ngrok` that manages its own binary and puts
|
||
|
|
it on your path, making `ngrok` readily available from anywhere on the command line and via a
|
||
|
|
convenient Python API.
|
||
|
|
|
||
|
|
[ngrok](https://ngrok.com) is a reverse proxy tool that opens secure tunnels from public URLs to localhost, perfect
|
||
|
|
for exposing local web servers, building webhook integrations, enabling SSH access, testing chatbots, demoing from
|
||
|
|
your own machine, and more, and its made even more powerful with native Python integration through `pyngrok`.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
`pyngrok` is available on [PyPI](https://pypi.org/project/pyngrok/) and can be installed
|
||
|
|
using `pip`:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
pip install pyngrok
|
||
|
|
```
|
||
|
|
|
||
|
|
or `conda`:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
conda install -c conda-forge pyngrok
|
||
|
|
```
|
||
|
|
|
||
|
|
That's it! `pyngrok` is now available as a package to our Python projects, and `ngrok` is now available from
|
||
|
|
the command line.
|
||
|
|
|
||
|
|
## Basic Usage
|
||
|
|
|
||
|
|
To open a tunnel, use the [`connect`](https://pyngrok.readthedocs.io/en/latest/api.html#pyngrok.ngrok.connect) method,
|
||
|
|
which returns the public URL generated by `ngrok`.
|
||
|
|
|
||
|
|
```python
|
||
|
|
from pyngrok import ngrok
|
||
|
|
|
||
|
|
# Open a HTTP tunnel on the default port 80
|
||
|
|
public_url = ngrok.connect()
|
||
|
|
# Open a SSH tunnel
|
||
|
|
ssh_url = ngrok.connect(22, "tcp")
|
||
|
|
```
|
||
|
|
|
||
|
|
The [`connect`](https://pyngrok.readthedocs.io/en/latest/api.html#pyngrok.ngrok.connect) method takes an optional
|
||
|
|
`options` parameter, which allows us to pass additional properties that are [supported by ngrok](https://ngrok.com/docs#tunnel-definitions).
|
||
|
|
|
||
|
|
This package puts the default `ngrok` binary on our path, so all features of `ngrok` are
|
||
|
|
available on the command line.
|
||
|
|
|
||
|
|
```sh
|
||
|
|
ngrok http 80
|
||
|
|
```
|
||
|
|
|
||
|
|
For details on how to fully leverage `ngrok` from the command line, see [ngrok's official documentation](https://ngrok.com/docs).
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
For more advanced usage, `pyngrok`'s official documentation is available at [http://pyngrok.readthedocs.io](http://pyngrok.readthedocs.io).
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
If you would like to get involved, be sure to review the [Contribution Guide](https://github.com/alexdlaird/pyngrok/blob/master/CONTRIBUTING.rst).
|
||
|
|
|
||
|
|
Want to contribute financially? If you've found `pyngrok` useful, [a donation](https://www.paypal.me/alexdlaird>) would
|
||
|
|
also be greatly appreciated!
|
||
|
|
|
||
|
|
Keywords: ngrok,tunnel,tunneling,webhook,localhost,reverse-proxy,localtunnel
|
||
|
|
Platform: UNKNOWN
|
||
|
|
Classifier: Environment :: Console
|
||
|
|
Classifier: Environment :: Web Environment
|
||
|
|
Classifier: Development Status :: 5 - Production/Stable
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: Intended Audience :: Education
|
||
|
|
Classifier: Intended Audience :: Information Technology
|
||
|
|
Classifier: Intended Audience :: System Administrators
|
||
|
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
|
Classifier: Operating System :: MacOS
|
||
|
|
Classifier: Operating System :: Microsoft :: Windows
|
||
|
|
Classifier: Operating System :: POSIX
|
||
|
|
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
|
||
|
|
Classifier: Operating System :: POSIX :: Linux
|
||
|
|
Classifier: Operating System :: Unix
|
||
|
|
Classifier: Programming Language :: Python :: 2
|
||
|
|
Classifier: Programming Language :: Python :: 2.7
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.5
|
||
|
|
Classifier: Programming Language :: Python :: 3.6
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|
||
|
|
Classifier: Programming Language :: Python :: 3.8
|
||
|
|
Classifier: Programming Language :: Python :: 3.9
|
||
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
||
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||
|
|
Classifier: Topic :: Database :: Database Engines/Servers
|
||
|
|
Classifier: Topic :: Internet
|
||
|
|
Classifier: Topic :: Internet :: Proxy Servers
|
||
|
|
Classifier: Topic :: Internet :: WWW/HTTP
|
||
|
|
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
|
||
|
|
Classifier: Topic :: Software Development :: Build Tools
|
||
|
|
Classifier: Topic :: Software Development :: Testing
|
||
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||
|
|
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
|
||
|
|
Description-Content-Type: text/markdown
|