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.3.tar.gz (17.2 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.3-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: create_tg_bot-0.1.3.tar.gz
  • Upload date:
  • Size: 17.2 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.3.tar.gz
Algorithm Hash digest
SHA256 c7dfadc44a635e8aba00db69ac7c9fcb7d810a996897b172afc79e12ee3d64c6
MD5 e9492ddce15e7069e7df367d71cd6a2e
BLAKE2b-256 2048904054d6597c630b52c010265309da8887f39b31544e5d3a4534a61d7761

See more details on using hashes here.

File details

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

File metadata

  • Download URL: create_tg_bot-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 08b3551cc4cd4e699d9ba3861f05cb10d1d3c12138e48031179b117c0c5c4460
MD5 6f67096ba90ba37ec05d2f3c3de30490
BLAKE2b-256 c0f6c2382bf01f3161af565c1ef32e735b7206b031a22cd0523e8903dfa8899a

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