yak-server 0.2.0

Football bet rest/graphql server

Yak-toto

Requisites

• Ubuntu 22.04
• Python 3.10.4
• MySQL 8.0.30

How to build the project

Database

Install and start mysql server on port 3306. Add a database named yak_toto. In root folder, create a dotenv file named .flaskenv and fill your MySQL user name, password and database. When backend start, this configuration is automaticaly loaded.

MYSQL_USER_NAME=my_user_name
MYSQL_PASSWORD=my_password
MYSQL_DB=my_database_name

You can also set MySQL port by adding MYSQL_PORT=my_port to .flaskenv file. If not set, it will be 3306 by default.

Backend

Run your project in a Python env is highly recommend. You can use venv with the following command:

python3 -m venv <my_env_name>

Then activate it with:

source <my_env_name>/bin/activate

Fetch all packages using poetry with the following command:

poetry install

Before starting the backend, add JWT_SECRET_KEY in .flaskenv same as the MySQL user name and password. As login system is using JSON Web Token, a secret key is required. To generate one, you can use the python built-in secrets module.

>>> import secrets
>>> secrets.token_hex(16)
'9292f79e10ed7ed03ffad66d196217c4'

JWT_SECRET_KEY=9292f79e10ed7ed03ffad66d196217c4

Also, automatic backup can be done through yak_server/cli/backup_database script and is able to send notification to Telegram bot. It can be run using flask db backup. To do so, please add a Telegram bot token and chat id to .flaskenv.

BOT_TOKEN=my_bot_token
CHAT_ID=my_chat_id

If the variables are not set, no telegram will be send.

Finally, flask needs some configuration to start. Please add FLASK_APP=yak_server variable to indicate main location. Last thing, for development environment, debug needs to be activated with a addditional environment variable:

FLASK_DEBUG=1

And then start backend with:

flask run

Data initialization

To run local testing, you can use the script create_database.py, initialize_database.py and create_admin.py located in yak_server/cli folder. To select, set COMPETITION environment variable in .flaskenv. It will read data from yak_server/data/{COMPETITION}/.

Testing

To set up test, please add a MySQL database named yak_toto_test. It will contain all the records created during unit tests. This database is cleaned everytime you run test. That's why a different database is created to avoid deleting records you use for your local testing.

Yak-server is using pytest to run tests and can run them using poetry run pytest command into root folder.

To generate xml report, run pytest --cov-report=xml --cov=yak_server tests/ -vv.