Skip to main content

A discord bot project helper with a useful command line interface

Project description

version python

Discord Bot CLI

An easy way to keep your discord bot projects consistant and work with their database using the command line. Inspired by Orator ORM.

Installation

pip install discord-bot-cli

Overview

Prefix: dbot

Available commands:

branches          Available branches of the discord bot base
docstring         Generate a docstring from a table name
help              Displays help for a command
list              Lists commands
migrate           Run the database migrations.
new               Creates a new discord bot base.
db
db:seed           Seed the database with records.
make
make:cog          Creates a new Cog extension.
make:command      Creates a new Command extension.
make:migration    Create a new migration file.
make:model        Creates a new Model class.
make:seed         Create a new seeder file.
migrate
migrate:install   Create the migration repository.
migrate:refresh   Reset and re-run all migrations.
migrate:reset     Rollback all database migrations.
migrate:rollback  Rollback the last database migration.
migrate:status    Show a list of migrations up/down.

Usage

This package is built off of the Orator ORM and most of the commands work the same way as in their documentation.

Example

dbot new bot_project --token=8675309

Would create a new full bot project directory called bot_project and will download the latest version of the discord bot framework. You can always change the token and your database connections in the config.yaml file in your projects main directory.

CD into the project directory and you can easily add a cog/command using the make command:

dbot make:cog new_cog
dbot make:command new_command

If you don’t need something so complex, you can use the -s or --simple flag. This will create a basic single file discord bot:

dbot new simple_bot -s -t 8675309

Requirements

orator==0.9.9
requests

License

This project is licensed under MIT - see the LICENSE file for details.

Notes

Here is the bot scaffolding the cli will download.

Different versions can be specified with the -b, --branch=BRANCH option for the new command.

Documentation for the Orator ORM

Documentation for discord.py

[v0.6]

Changelog

  • Added a -s / --simple option to the new command that will create a simple single bot file. For when you don’t need something so robust. Example dbot new simple_bot -s -t 8675309
  • Added a docstring command to generate information about a table. Example dbot docstring user_table

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for discord-bot-cli, version 0.6.4
Filename, size File type Python version Upload date Hashes
Filename, size discord_bot_cli-0.6.4-py3-none-any.whl (24.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size discord_bot_cli-0.6.4.tar.gz (13.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page