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.

DPyCLI 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

DPyCLI 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

DPyCLI-0.1.0b0.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

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

DPyCLI-0.1.0b0-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: DPyCLI-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 DPyCLI-0.1.0b0.tar.gz
Algorithm Hash digest
SHA256 1a6c12983e6b75f22ced7706a3ef122f76a160cb6a896f3515113d33088fab7d
MD5 9fd1e48ed2f4d65317c5b342b70eb86e
BLAKE2b-256 f4e38cf5c69e98650eee894a1769360144ca76ba11109d560f6ab92d1773ba70

See more details on using hashes here.

File details

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

File metadata

  • Download URL: DPyCLI-0.1.0b0-py3-none-any.whl
  • Upload date:
  • Size: 14.8 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 DPyCLI-0.1.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 db0b3c582472a78fecdb5b1bb30f78a1bdd26427189598692a91df7c603ade06
MD5 e5116365336b79532689342a935e1f5a
BLAKE2b-256 ff35b720a2bec703dbe72ea76bbbfaf9a44075ff1dce0d92f3ab8201766682e4

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