Skip to main content

A modular, CLI-first Python boilerplate for building Telegram bots. Fast setup, clean architecture, and open-source ready.

Project description

create-tg-bot

PyPI version License: MIT CI/CD

📖 This README is also available in 🇷🇺 Russian

create-tg-bot is a CLI tool for rapidly creating clean-architecture Telegram bots using Python.


🚀 Features

  • Quickly scaffold a new project structure
  • SQLite and PostgreSQL support
  • Environment variable and .env management
  • Generates Dockerfile and GitHub Actions workflows
  • Automatic database migrations (Alembic)
  • Optional development and production bot tokens
  • Ready for PyPI publishing
  • Includes testing with pytest

📦 Installation

pip install create-tg-bot

🛠️ Usage

create-tg-bot <project_name>

Example

create-tg-bot my_bot_project

This creates a fully-structured bot project and initializes it with environment setup, dependency installation, migrations, and Git repository initialization.


📁 Project Structure

project/
├── .env
├── alembic.ini
├── config.py
├── main.py
├── models/
├── services/
├── crud/
├── migrations/
├── templates/
├── requirements.txt
└── .github/workflows/

🧪 Development Notes

  • Uses setuptools_scm for automatic versioning
  • Templates live in create_tg_bot/templates
  • CLI interface powered by Click

📄 License

This project is licensed under the MIT License.


👤 Author

Emil Astanov

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

create_tg_bot-0.1.2.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

create_tg_bot-0.1.2-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file create_tg_bot-0.1.2.tar.gz.

File metadata

  • Download URL: create_tg_bot-0.1.2.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for create_tg_bot-0.1.2.tar.gz
Algorithm Hash digest
SHA256 052e53c775b674fe8de6f605fa8c1bbc0916d30d7da70576ed46d2c0063a584f
MD5 8a0d8a5ab775fc45ad4c15c15a6f0d9b
BLAKE2b-256 d83853d1e935b3340c24ca4cb284d7a9f9c922260f6f568013be6c12cbf5ff87

See more details on using hashes here.

File details

Details for the file create_tg_bot-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: create_tg_bot-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for create_tg_bot-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 56a1c2860322e536d186908b8cb5b2a6639b73c0a9003fc6f0aefd05a92253ee
MD5 f03d8d2ba20cc9bc2e9e067e03fdde8f
BLAKE2b-256 aa2d9cf3eb36178d2444ccdf055bcb0557cca18f26852ac8f454b81664a41996

See more details on using hashes here.

Supported by

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