Status Badges | Code Coverage |
---|---|
|
A Dockerfile is provided that will also automagically setup a bot environment for local development, running, and debugging.
docker build . -t voluspa
docker run -it voluspa:latest python3.11 ./voluspa.py
docker run -it -v ${pwd}:/app/voluspa voluspa:latest python3.11 ./voluspa.py
So you like doing things the hard way, that's totally cool also! Here are some instructions to run everything natively, GLHF!
- Uses Python 3.11.2
- Setup assumes Debian based package manager
- Setup shows how to install Python using the Deadsnakes PPA
- If using Ubuntu 20.04 "Focal Fossa", you won't need to add the Deadsnakes PPA, as Python 3.8 is bundled with the OS
-
Install the bare essentials
apt update && apt install git software-properties-common
-
Add the Deadsnakes PPA
apt-add-repository ppa:deadsnakes/ppa && apt update
-
Install Python and related packages
apt install python3.11 python3.11-dev python3.11-venv python3-pip
-
Clone the Voluspa repository
git clone https://github.com/Ghost-Proxy/Voluspa.git && cd Voluspa/
-
These packages may be necessary to build from source if binaries aren't available for Voluspa's dependencies
apt install build-essentials libfreetype6-dev
-
Create and enter a virtual environment
python3.11 -m venv ./venv && source venv/bin/activate
(To deactivate a virtual environment, just type
deactivate
) -
Upgrade pip
python3.11 -m pip install -U pip
-
If building dependencies from source, you will need wheel
python3.11 -m pip install wheel
-
Install dependencies
pip3 install -r requirements.txt
-
Create (and populate) a secrets file, or set secrets in your environment
WARNING: DO NOT share or commit your secrets. Accidental commits should be prevented by the .gitignore
cp config/config.yaml config/secrets.yaml
-
Start Voluspa
python3.11 voluspa.py
-
Happy coding and have fun!
💜