PaiGram

Introduction

Depending on your preferred environment, follow one of the setups below:

For contributors using WSL2 on Ubuntu 22.04, follow the detailed guide here.

git clone git@github.com:PaiGramTeam/PaiGram.git
cd PaiGram/
git submodule update --init --recursive

It's recommended to use a virtual environment. You can set it up via venv or virtualenv.

Create Virtual environment:

python3 -m venv venv

Activate the virtual environment:

For Linux:

source venv/bin/activate

For Windows Command Prompt:

venv\Scripts\activate.bat

For Windows PowerShell:

.\venv\Scripts\Activate.ps1

Install Dependencies:

pip install poetry
poetry install --extras all
playwright install chromium

Optional Dependencies

poetry install --extras all

Edit Config:

Create a dotenv config (.env) based on the given example. Ensure to provide the necessary database connection details and bot token parameters.

cp .env.example .env

For detailed configurations, refer to the Wiki/Env Settings.

alembic upgrade head

Ensure the venv is still active:

python ./run.py

This project is currently being expanded, adding more entertainment and information query features related to Genshin Impact. Stay tuned!