README.md

Pyrostarter

A CLI tool for creating Pyrogram ready to start project structure.

Overview

└── repo_name
    └── .venv (optional)
    └── pyproject.toml (optional)
    └── project_name
        ├── plugins
        │   └── say_hello.py
        ├── utils
        │   └── buttonator.py
        ├── __init__.py
        ├── __main__.py
        ├── BotConfig.py
        └── botname.ini

Installation

pip install pyrostarter

Usage

Create a directory for your project. In your project directory run the command and follow the instructions:

$ mkdir YourProject
$ cd YourProject
$ pyrostarter init

This command will guide you through creating your Telegram Bot template.

Project name: <project_name>
Bot name: <BotName> (PascalCase recommended)

API ID, API Hash and Bot Token are optional.
You can enter manually to .ini file after setup.

Your API ID: <api_id>
Your API Hash: <api_hash>
Your Bot Token: <bot_token>
Is user bot?: (yes/no) [no] 
Virtual enviroment? Built-In, Poetry, No Venv (b/p/n):

Run your project

python -m <project_name>

Credits

Pyrogram | Telegram MTProto API Framework for Python Dan | Creator of Pyrogram