Skip to main content

A Discord.py CLI to generate boilerplate code, add dependencies and cogs.

Project description

Discord.py Command Line Interface

A library built by Amelia Cabotte and RaviAnand Mohabir.

DiscordPyCLI is a set of command line tools inspired by packages such as npx and vue cli to aid in creating Discord.py bots. The interface enables fast creation of Python projects that follow all the file structure conventions and are typed properly. Goodies such as configuration files, which can be either INI, YAML, Python or .env files are supported as well, and a custom .gitignore keeps your client information safe.

Usage

DiscordPyCLI is launched with the dpy command with numerous options and flags.

Creating a Bot

The dpy create command allows you to use numerous flags and options to create a Discord.py bot which

  • name: The project's name, can be snake, kebab or camel case.
  • --cog: Supply cogs that should be generated with the bot.
  • --basic: Flag to create a simple instance of a commands.Bot, instead of the full class implementation.

Running dpy create my-bot --cog=TestCog and leaving all the prompts at their default will create the following base folder structure:

my-bot /
  .gitignore
  my_bot.py
  requirements.txt
  discord.yaml
  cogs /
    __init__.py
    test_cog.py

By default the script will also generate a boilerplate help command by Dan6erbond#2259 with support for pagination and customized outputs. The bot's command prefix, description and support for Banhammer.py can all be customized during the command-run, as you will be prompted to supply additional information.

Roadmap

  • bot add cog
  • bot add cmd
  • bot db create
  • bot db model

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

DiscordPyCLI-0.1.0b0.tar.gz (2.7 kB view hashes)

Uploaded Source

Built Distribution

DiscordPyCLI-0.1.0b0-py3-none-any.whl (14.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page