Clone repository and initialize submodule

git clone --recurse-submodules https://github.com/ivanlonel/showdown_dex.git
cd showdown_dex
# If you forgot --recurse-submodules on git-clone, run this:
git submodule update --init --recursive

You may need to install python3-venv for the next step. For example, on Debian:

sudo apt update && sudo apt install python3-venv

Create virtual environment, activate it and upgrade its pip

python3 -m venv env  # --upgrade-deps  # This option is Python 3.9+ only
source env/bin/activate
python -m pip install --upgrade pip  # If venv was not created with --upgrade-deps

Install python dependencies in virtual environment

pip install -r requirements.txt

Download smogon analyses as json files

python smogon_analyses.py

Fire up the database. Unless you're using Docker Desktop with WSL, you must have docker and docker-compose installed.

sudo docker-compose up --detach

ETL data from json and ts files into the database

python showdown_dex.py

Done. Database is running and ready to be queried.

The repository and the submodule can be updated like this:

git pull --recurse
git submodule update --remote --rebase

Sets and strategies are © 2004-2021 Smogon.com and its contributors. Pokémon and all respective names are Trademark & © of Nintendo 1995-2021.