# BotForge - Telegram Bot Library
BotForge is a lightweight Python library designed to simplify the development of Telegram bots. It provides a simple interface to interact with the Telegram Bot API and includes features for handling commands.
## Features
- Easy setup for Telegram bots
- Command handling with decorators
- Simplified interaction with the Telegram Bot API
## Installation
You can install BotForge using pip:
```bash
pip install BotForge
```
## Usage
```python
# Import BotForge and necessary modules
import time
from functools import wraps
from BotForge import BotForge, CommandContext
# Initialize BotForge with your bot token
bot = BotForge(token="YOUR_BOT_TOKEN")
# Define command handlers using decorators
@bot.command_handler("/start")
def hello(ctx):
bot.send_message(ctx.chat_id, f"Hello, {ctx.username}")
@bot.command_handler("/help")
def help_command(ctx):
bot.send_message(ctx.chat_id, f"Hello again! {ctx.username}")
# Start the bot
bot.start()
```
## Contributing
Contributions are welcome! If you have any ideas, bug reports, or feature requests, please open an issue on the [GitHub repository](https://github.com/KailUser/BotForge).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Replace `"YOUR_BOT_TOKEN"` with the actual token of your Telegram bot. Additionally, make sure to replace the placeholder link to the GitHub repository with the actual URL once you have it.
Feel free to add more sections to the README file as needed for your project.
Raw data
{
"_id": null,
"home_page": "https://github.com/KailUser/BotForge",
"name": "BotForge",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Syirezz",
"author_email": "syirezz@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/56/bd/6b9842b6f28040712776f2b4b501a8ffa54af02b7525f530ab45c4775014/BotForge-0.0.3.tar.gz",
"platform": null,
"description": "# BotForge - Telegram Bot Library\r\n\r\nBotForge is a lightweight Python library designed to simplify the development of Telegram bots. It provides a simple interface to interact with the Telegram Bot API and includes features for handling commands.\r\n\r\n## Features\r\n\r\n- Easy setup for Telegram bots\r\n- Command handling with decorators\r\n- Simplified interaction with the Telegram Bot API\r\n\r\n## Installation\r\n\r\nYou can install BotForge using pip:\r\n\r\n```bash\r\npip install BotForge\r\n```\r\n\r\n## Usage\r\n\r\n```python\r\n# Import BotForge and necessary modules\r\nimport time\r\nfrom functools import wraps\r\nfrom BotForge import BotForge, CommandContext\r\n\r\n# Initialize BotForge with your bot token\r\nbot = BotForge(token=\"YOUR_BOT_TOKEN\")\r\n\r\n# Define command handlers using decorators\r\n@bot.command_handler(\"/start\")\r\ndef hello(ctx):\r\n bot.send_message(ctx.chat_id, f\"Hello, {ctx.username}\")\r\n\r\n@bot.command_handler(\"/help\")\r\ndef help_command(ctx):\r\n bot.send_message(ctx.chat_id, f\"Hello again! {ctx.username}\")\r\n\r\n# Start the bot\r\nbot.start()\r\n```\r\n\r\n## Contributing\r\n\r\nContributions are welcome! If you have any ideas, bug reports, or feature requests, please open an issue on the [GitHub repository](https://github.com/KailUser/BotForge).\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\nReplace `\"YOUR_BOT_TOKEN\"` with the actual token of your Telegram bot. Additionally, make sure to replace the placeholder link to the GitHub repository with the actual URL once you have it.\r\n\r\nFeel free to add more sections to the README file as needed for your project.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BotForge - tiny bot api for telegram",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/KailUser/BotForge"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56bd6b9842b6f28040712776f2b4b501a8ffa54af02b7525f530ab45c4775014",
"md5": "cea1bf2e510193aa3223ba1f9cea1762",
"sha256": "9ec8b5eb1c175ac8860d697a26c13f2790f80f03fb8d8ab10cfa36815d16eb79"
},
"downloads": -1,
"filename": "BotForge-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "cea1bf2e510193aa3223ba1f9cea1762",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3881,
"upload_time": "2024-01-25T12:40:36",
"upload_time_iso_8601": "2024-01-25T12:40:36.945175Z",
"url": "https://files.pythonhosted.org/packages/56/bd/6b9842b6f28040712776f2b4b501a8ffa54af02b7525f530ab45c4775014/BotForge-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 12:40:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KailUser",
"github_project": "BotForge",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "botforge"
}
JSON
