Metadata-Version: 2.4
Name: telegrambotcli
Version: 0.5.2
Summary: A utility for quickly generating projects on aiogram 3
Author-email: AnonimPython <moscow.retro@list.ru>
Keywords: aiogram,cli,generator,telegram,bot
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: typer[all]
Requires-Dist: sqlmodel
Requires-Dist: aiogram>=3.0.0
Requires-Dist: pydantic-settings
Requires-Dist: psycopg2
Requires-Dist: python-dotenv
Requires-Dist: pydantic

## 🚀 TelegramBotCLI

A lightweight command-line utility for quickly generating professional project structures for **Aiogram 3** bots. Stop wasting time on boilerplate and start coding your logic instantly.

## ✨ Features

- **Standard & Advanced Templates:** Choose between a lightweight setup or a production-ready structure.
- **Pro Components:** Includes **Anti-flood Middleware** and **Admin Filters** out of the box.
- **Database Ready:** Pre-configured **SQLModel** (SQLite/PostgreSQL) integration.
- **Smart OS Detection:** Suggests the correct run command (`python` vs `python3`) for your system.
- **Automated Init:** Handles all `__init__.py` files automatically for clean imports.

## 📦 Installation

Install the tool directly from PyPI:

```bash
pip install telegrambotcli
```


## 🌞 How to Start

Open your terminal in the desired project folder and run:

bash

```
telegrambotcli
```

You will be prompted to choose a template:

1. **[Standard]** **: Basic bot with DB, Keyboards, and essential handlers.**
2. **[Advanced]** **: Includes Admin logic, Anti-flood protection, and advanced filtering.**

📂 Generated Project Structure

text

```
your_project/
├── app/
│   ├── database/
│   │   └── database.py    # SQLModel engine & User model
│   ├── filters/           # (Advanced) AdminFilter logic
│   ├── keyboards/
│   │   └── builders.py    # Reply & Inline keyboard templates
│   ├── middlewares/       # (Advanced) Anti-flood middleware
│   └── main.py            # Main Router (Help, Settings, Admin handlers)
├── bot.py                 # Main entry point (Dispatcher & Polling)
├── .env                   # Environment variables (Token, Admin ID)
└── .gitignore             # Pre-configured for Python & VSCode
```


## 🚀 Quick Start Guide

1. **Configure:** **Open the generated** `.env` **file and fill in your credentials:**
   env

   ```
   BOT_TOKEN="123456:ABC-DEF..."
   ADMIN_ID="987654321"
   ```
2. **Run:** **Launch your bot using the suggested command:**
   bash

   ```
   python bot.py  # or python3 bot.py
   ```

### 🛠 Handlers Included

The generated `app/main.py` automatically includes:

* `/start`, `/keyboard`, `/inline`
* **Text filters** **for "Help 🆘" and "Settings ⚙️" buttons.**
* **Admin check** **for the** `/admin` **command (in Advanced mode).**

## 🧑‍💻GitHub repository

[Sourse code](https://github.com/AnonimPython/telegrambotcli)
[PyPi page](https://pypi.org/project/telegrambotcli/)
