discord-bot-cli 0.6.4
A discord bot project helper with a useful command line interface
License: MIT
Requires Python: >=3.6,<4.0
Keywords: discord,discord.py,orator,discord bot

|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 <https://github.com/sdispater/orator>`__.

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 <https://orator-orm.com/docs/0.9/>`__.

Example
-------

.. code:: text

    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 <https://github.com/stroupbslayen/discord-bot>`__. 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:

.. code:: text

    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:

.. code:: text

    dbot new simple_bot -s -t 8675309

Requirements
~~~~~~~~~~~~

::

    orator==0.9.9
    requests

License
-------

This project is licensed under MIT - see the `LICENSE <LICENSE>`__ file
for details.

Notes
~~~~~

`Here is the bot scaffolding the cli will
download <https://github.com/stroupbslayen/discord-bot>`__.

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

Documentation for the `Orator ORM <https://orator-orm.com/docs/0.9/>`__

Documentation for
`discord.py <https://discordpy.readthedocs.io/en/latest/>`__

[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``

.. |version| image:: https://img.shields.io/pypi/v/discord-bot-cli
.. |python| image:: https://img.shields.io/badge/python-3.6+-blue