Easy and fast tool written in python 3 to get info about running ngrok tunnel
Project description
Get ngrok tunnel info
Easy and fast tool written in python 3 to get info about running ngrok tunnel. Supports HTTPS and TCP
Installation
-
Windows / macOS
Run
python3 -m pip install ngrok_info
-
Linux
Run
python3 -m pip install ngrok_info
Usage
-
Windows / macOS / Linux
Add this to your script:
import ngrok_info
ngrok_info.get()
Now, if you run it, you will see output with some info. If ngrok is not running on your computer, it will output error. After you run it, you can acess the info as variables too!
If you are using config file to specify tunnel preset, use
ngrok_info.get("TUNNEL_NAME")
(Replace TUNNEL_NAME with your tunnel name. Please do not delete quotation marks.)If you do not want output, but only variables, use
ngrok_info.get_notext()
If tunnel is TCP, you have access these variables:
ngrok_info.tnl_name
,ngrok_info.tnl_type
,ngrok_info.adress
,ngrok_info.ip
andngrok_info.port
.With https tunnel, you can acess these variables:
ngrok_info.tnl_name
,ngrok_info.tnl_type
,ngrok_info.adress
andngrok_info.ip
.
Uninstallation
-
Windows / macOS
Run
python3 -m pip uninstall ngrok-info
-
Linux
Run
python3 -m pip uninstall ngrok-info
FAQ
-
Error: wrong tunnel name specified or no tunnel is running
Check if ngrok is really running on your computer. If yes, check if you have correctly specified tunnel name. You need to specify it only, if you are using config file to specify tunnel preset. If you've checked everything, but it's still not working, contact us on Discord or open issue.
Do you like this? Hit that ⭐!
Use the star button as way to show us, that it works
Forks and pull requests are welcome of course
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ngrok_info-1.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be0bd161314b3722eff6882bab7699e7dd25485b09b8865152db543e2cf1adda |
|
MD5 | d03e82f4fafd20e9e4dc80e0e65e9a9e |
|
BLAKE2b-256 | 23878635c9f8ad4c888d582972c5b36b92c6dc909a827269493d1b7625bd9eb9 |