Quick Start

Following these steps will allow you to see PyStark in action as quickly as possible.

Note

Installation of Python with version 3.6 or above is required.

---

Steps

1. Open up your terminal.

2. Install PyStark with pip

$ pip3 install pystark

3. Generate a boilerplate using PyStark’s command-line tool.

$ pystark --boilerplate

4. Enter the newly created boilerplate directory.

$ cd boilerplate

5. Open the file manager in current directory.

6. Edit the .env file and fill your API_ID, API_HASH and BOT_TOKEN. Get the API keys from my.telegram.org and bot token from BotFather.

7. Run the bot using python

$ python3 bot.py

---

What does this do?

The above steps will help you set up your bot and run it. You can use the command /start to check if your bot is actually running.

Your bot now has four default commands:

/start - Start the bot. /help - See a help message for the bot. /about - About the bot. /id - Get Telegram ID (also works in groups)

Stop the bot using Ctrl+C.