Skip to main content

A simple Quick discord bot generator that will make all the necessary starter files.

Project description

QuickBot

QuickBot Logo

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.py or .env for 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:

quickbot

You'll be prompted with a series of questions to customize your bot:

  • Programming Language (Currently only Python is supported)
  • Configuration Method (config.py or .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?

Happy coding! ๐ŸŽฉโœจ

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

quickdiscord-1.0.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

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

quickdiscord-1.0.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file quickdiscord-1.0.0.tar.gz.

File metadata

  • Download URL: quickdiscord-1.0.0.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

Hashes for quickdiscord-1.0.0.tar.gz
Algorithm Hash digest
SHA256 16113891431dc08afa5cba7226fa4508911b1aa4795a6c2b6e65961f6b0ca81a
MD5 79a27cd644f6c0b01a5c3dd0c7f93058
BLAKE2b-256 d8b07a09e8aa45b9e046238849dc6db3f86de2d8c64c59c75e9ca7d21c395884

See more details on using hashes here.

File details

Details for the file quickdiscord-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: quickdiscord-1.0.0-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

Hashes for quickdiscord-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b4e937fbb5e8a33811c37fca365ec4cc84c6ef6f284d8cbf3c0b93ca29b325b
MD5 de2b86d8c25c302b2f6b670a4f732a4a
BLAKE2b-256 586d7748d45be3f4e6e3f42cdf55ed54d22ea6eb0eda9f463e95ad051741f803

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