tgram-dnd 0.0.7b0

Tgram Darg-And-Drop helper is a lib to help building DragAndDrop applications, or simply just to make bots faster

Tgram-DND

a helper/utils library to help build Telegram Bot Drag-And-Drop Applications
Documentation • Examples

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About Project

tgram_dnd is a helper/utils library to help build Telegram Bot Drag-And-Drop application by seperating the bot logic into manageable chunks

(back to top)

Built With

• tgram (Bot API Interaction)
• jinja2 (string templating)

(back to top)

Getting Started

Prerequisites

• python>=3.10
• tgram>=1.12.16
• jinja2>=3.1.5

Installation

1. Clone From Source (Not Recommended)
    * git clone https://github.com/PythonNoob999/tgram_dnd.git
    * cd tgram_dnd
    * python3 -m pip install . -U
    * done✅

2. Installing From PIP (Recommended)
    * python3 -m pip install tgram_dnd
    * done ✅

Usage

Bot Setup

from tgram_dnd import (
  App, BotConfig, MessageFlow, MessageBlock, Reply
)
from tgram import TgBot

bot = TgBot("INSERT_BOT_TOKEN")
app = App(
  bot=bot,
  config=BotConfig(
    strings="text.json",
    default_lang="en"
  ),
)

app.add_flows(
  MessageFlow(
    ...
  )
)

app.run()

Examples

Roadmap

• Add Documentaion
• Adding More Abstracted Methods
• Configuration System (db_setup, strings, etc) (50%)
• JsonToBlocks Converter

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3 License. See LICENSE.txt for more information.

(back to top)

Contact

SpicyPenguin - telegram

(back to top)