Development installation

Everyone’s development environment is different. This is an attempt to make it as easy as possible to setup.

Forking the bot

Fork is a repository that is a copy of another repository. By performing a fork you’ll be able to experiment and alter modules withou affecting the main, official repository. The fork is also used for opening Pull Requests back to our repository.

Note

This section also applies to pumpkin.py module repositories, not just main repository. Just change the URLs.

Open our official GitHub page. Assuming you are logged in, you should see a button named Fork (at the top right). Click it.

After a while, the site will load and you’ll see the content of your fork repository, which will look exactly the same as the official one – because it’s a copy.

Under a colored button Code, you can obtain a SSH URL which will be used with git clone to copy it to your local machine.

Note

This manual will assume you have your SSH keys set up. It’s out of scope of this manual to describe full steps. Refer to GitHub documentation or use your preferred search engine.

System setup

You’ll need git. It may be on your system already.

apt install git

Besides git, pumpkin.py has additional system dependencies which have to be installed.

apt install \
    python3 python3-dev python3-pip python3-venv python3-setuptools \
    gcc libffi-dev \
    libjpeg-dev libtiff-dev libwebp-dev libopenjp2-7-dev

Code setup

Clone your fork:

git clone git@github.com:<your username>/pumpkin-py.git pumpkin
cd pumpkin

Then you have to setup a link back to our main repository, which is usually called upstream:

git remote add upstream https://github.com/pumpkin-py/pumpkin-py.git

Database

Instead of high-performance PostgreSQL we are going to be using SQLite3, which has giant advantage: it requires zero setup.

Open file .env (see Environment file for more details) and paste the following connection string into the DB_STRING variable: sqlite:///pumpkin.db.

If you ever need to wipe the database, just delete the pumpkin.db file. The bot will create a new one when it starts again.

Discord bot token

See Bot token in chapter General Bot Information.

Bot environment

See Virtual environment in chapter General Bot Information for instructions on how to setup a virtual environment.

Once you are in virtual environment, you can install required libraries:

python3 -m pip install wheel
python3 -m pip install -r requirements.txt
python3 -m pip install -r requirements-dev.txt

Before the bot can start, you have to load the contents of .env file into your working environment. After any changes to .env, this process must be performed for the changes to take place. This can be done by running

set -o allexport
source ./.env
set +o allexport

Note

See A small tip in venv’s section in chapter General Bot Information to learn how to make this automatically. For development this approach is highly recommended. For update of .env either deactivate and activate venv or update it manualy.

Running the bot

python3 pumpkin.py

If you have done everything correctly (you are in venv, you have all libraries installed), the script will print startup information and a welcome message, something like this:

Imported database models in modules.base.base.database.
Imported database models in modules.base.admin.database.
Loaded module base.acl
Loaded module base.admin
Loaded module base.base
Loaded module base.logging
Loaded module base.errors
Loaded module base.language
     (
  (   )  )
   )  ( )
   .....
.:::::::::.
~\_______/~
2022-02-18 08:18:02 CRITICAL: The pie is ready.