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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file DiscordPyCLI-0.1.0b0.tar.gz.

File metadata

  • Download URL: DiscordPyCLI-0.1.0b0.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for DiscordPyCLI-0.1.0b0.tar.gz
Algorithm Hash digest
SHA256 da1ee4800af76688316f93fd2212d6652b956fafd7153e1451846cbb6da97598
MD5 58638930aa76aa2b3f787aab9b48bdff
BLAKE2b-256 9a49df4e0cf7cfcd2064185c7695ad52b74406422768d1cb796b2d2c11c8390d

See more details on using hashes here.

File details

Details for the file DiscordPyCLI-0.1.0b0-py3-none-any.whl.

File metadata

  • Download URL: DiscordPyCLI-0.1.0b0-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for DiscordPyCLI-0.1.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 c3ea18d61feef9e07b9d4b8211cdf5c0793bdc2dd9e5d06c239fb4ba7cfcb1b8
MD5 cae6cf4cee2d2905bec1468ca134dced
BLAKE2b-256 f0daa77554398ad69a7ed8b81ae8156af755243855fe00f289c8701c7eb5be16

See more details on using hashes here.

Supported by

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