xxami/echidna

discord.py intro

echidna.py

quick reference for python gaijins setting up a discord.py bot using tools that make sense in 2020

step 0: install python 3

python 2 is over, let's make sure we're running with python 3 (https://www.python.org/downloads/)

$ python --version
> Python 3.7.4

step 1: the package manager

discord.py is not included as part of pythons standard library, so we'll use a package manager to pull it in. i like poetry, but there are several alternatives. get poetry here: https://python-poetry.org/docs/

$ poetry --version
> Poetry version 1.0.5

step 2: create a new project

using poetry:

$ poetry new echidnabot
$ cd echidnabot

poetry will kindly generate a project with a standard python directory structure. part of that is preparing pytest for us, a module we can use to unit test our projects.

$ poetry install
$ poetry run pytest tests

great, we've got tests that can refer to our project and pass! now we need an app:

$ cd echidnabot
$ echo "def init(): print('nyaa~ world')" >> main.py
$ cat main.py
$ cd ..

we can add an entry point to help us run our code in pyproject.toml:

[tool.poetry.scripts]
start = "echidnabot.main:init"

and run simply by using: $ poetry run start

step 3: write the bot of your dreams!

musn't forget the part where we add discord.py to the project:

$ poetry add discord.py

see here for a good starting point :)!