Skip to main content

Keep ngrok free tier alive

Project description

FastAPI

Keep your ngrok free tier alive, forever


! Use this tool for personal use only, for prototyping projects and related things. For commercial or production use consider subscribing to ngrok.

Prerequisites

  • Ngrok already configured with your key
  • A bot on telegram

installation

  • With pip

    pip3 newgrok
    
  • With poetry:

    poetry add newgrok
    

Variables

Variable
app_port Port of the application running on your machine
protocol Network protocol you want to use
bot_token Your bot token in telegram
chat_id The id of the chat between the bot and you

Setup

  • First you need to set the environment variables, chat_id for later, edit the .env file
    app_port=8000
    protocol=http
    bot_token=******************************
    chat_id=
    
  • To get the chat_id, run:
    chat_id
    
    Now send a message to the bot, and it will reply with the chat_id. Complete the .env file
    app_port=8000
    protocol=http
    bot_token=******************************
    chat_id=********
    
  • Now with these 3 lines of code, newgrok is already running, enjoy
    from newgrok import Newgrok
    
    ngrok = Newgrok()
    ngrok.run()
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

newgrok-0.4.0.tar.gz (3.5 kB view hashes)

Uploaded Source

Built Distribution

newgrok-0.4.0-py3-none-any.whl (4.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page