A simple Quick discord bot generator that will make all the necessary starter files.
Project description
QuickBot
A simple and efficient Discord bot generator that helps you set up a bot with database support, cogs, and environment configurations in seconds! ๐
โจ Features
- ๐ง Quick Setup โ Generate a fully functional Discord bot project effortlessly.
- ๐ Modular Cogs Support โ Choose to use cogs for a structured and scalable bot.
- ๐ข๏ธ Database Integration โ Supports SQLite, PostgreSQL, and MongoDB.
- โ๏ธ Configurable Environment โ Use either
config.pyor.envfor storing credentials. - ๐ฆ Automated Dependency Installation โ Installs required packages automatically.
๐ Installation
Prerequisites
Make sure you have Python 3.8+ installed.
python --version
Install QuickBot
pip install quickbot
๐ Usage
To generate a new bot project, run:
python -m quickbot
You'll be prompted with a series of questions to customize your bot:
- Programming Language (Currently only Python is supported)
- Configuration Method (
config.pyor.env) - Use Cogs? (Modular command files)
- Database Type (None, SQLite, PostgreSQL, MongoDB)
After answering the prompts, QuickBot will generate the project structure and install dependencies automatically. ๐
๐ Project Structure
๐ฆ YourBotProject
โโโ ๐ cogs/ # Stores command files (if cogs are enabled)
โ โโโ __init__.py
โ โโโ example.py # Example cog
โโโ ๐ main.py # Main bot file
โโโ ๐ config.py # Stores bot token and prefix (if config.py is chosen)
โโโ ๐ .env # Stores bot token and prefix (if .env is chosen)
โโโ ๐ database.py # Database setup file (if a database is selected)
โโโ ๐ requirements.txt # Installed dependencies
๐ง Available Commands
Once your bot is running, you can use these basic commands:
| Command | Description |
|---|---|
!hello |
Responds with "Hello!" |
| More... | Add your own commands! |
๐ ๏ธ Supported Databases
QuickBot allows you to choose a database during setup:
- SQLite (Default, lightweight, file-based)
- PostgreSQL (Enterprise-level, requires
psycopg2) - MongoDB (NoSQL database, requires
pymongo)
๐ก Example
After generating your bot, navigate to your project folder and run:
python main.py
Your bot should now be running! ๐
๐ฏ Contributing
We welcome contributions! Feel free to submit a pull request or open an issue.
๐ License
QuickBot is open-source and licensed under the MIT License.
๐ฌ Need Help?
- ๐ Official Discord.py Documentation
- ๐ ๏ธ Open an issue if you run into problems!
Happy coding! ๐ฉโจ
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quickdiscord-1.0.1.tar.gz.
File metadata
- Download URL: quickdiscord-1.0.1.tar.gz
- Upload date:
- Size: 5.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e19961080bb4678afab69e8cfef94e1eb6b3a13a48c174da5c9cb1c1a440c10
|
|
| MD5 |
2f3f23aa894f7e82f3e38bb09805c5a7
|
|
| BLAKE2b-256 |
5727c46ce8f434d524f2c7abd81a61c0ba5b037649fc4e8c07c218d9ad6ace20
|
File details
Details for the file quickdiscord-1.0.1-py3-none-any.whl.
File metadata
- Download URL: quickdiscord-1.0.1-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e1e46296471d84a0978b99f775afe218c43fd1a1ad5afe3c41791d3f21839df7
|
|
| MD5 |
c9ab2fb14895e5c86bb16947a9b959cf
|
|
| BLAKE2b-256 |
1f944786deb36944ed56b2a3bf50c7c0764bdd703a0037f7c3ac1d4f10a5d3cb
|