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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file newgrok-0.4.0.tar.gz.

File metadata

  • Download URL: newgrok-0.4.0.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.8 Linux/6.0.10-arch2-1

File hashes

Hashes for newgrok-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f729a94218e44750bbf3f41b4580d3539343893c2114bfa1e6fbb2b808b1546e
MD5 06e4a751c04c57451f3607aa7d519f8c
BLAKE2b-256 04ac8c91de739f7e6b07ac422d13d60506d6c09fa09cfc54cebe508e516f60bc

See more details on using hashes here.

File details

Details for the file newgrok-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: newgrok-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.8 Linux/6.0.10-arch2-1

File hashes

Hashes for newgrok-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8941f4fa961996fe286442ce9e50509b47e1920cba9cd857e7078b9a44d6d03f
MD5 34ea1a93e4abe72a454777574fdccaac
BLAKE2b-256 d0fb396711e227aa92cdae01a349d03bc28387cbb74c8990953d81733427c7df

See more details on using hashes here.

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