Yak-toto
Requisites
- Ubuntu 22.04
- Postgres 17.2
How to build the project
Database
To setup a database, run yak env init. This will ask you to fill different configuration in order build env file.
Once done, you can run a docker script to start postgres database (at scripts/postgresrun.sh)
Backend
Run your project in a Python env is highly recommend. You can use venv python module using the following command:
uv venv
. .venv/bin/activate
Fetch all packages using uv with the following command:
uv pip install -e .
Before starting the backend, add JWT_SECRET_KEY and JWT_EXPIRATION_TIME in .env same as the Postgres user name and password. As
login system is using JSON Web Token, a secret key is required and an expiration time (in seconds). To generate one, you can use the python built-in secrets module.
>>> import secrets
>>> secrets.token_hex(16)
'9292f79e10ed7ed03ffad66d196217c4'
JWT_SECRET_KEY=9292f79e10ed7ed03ffad66d196217c4
JWT_EXPIRATION_TIME=1800
Signup is gated behind an invite token to prevent unwanted account creation. Set SIGNUP_TOKEN to a short alphanumeric value in .env and share it out-of-band with people you want to allow to sign up; it must be sent as the signup_token field in the signup request body.
SIGNUP_TOKEN=A1B2C3
Also, automatic backup can be done through yak_server/cli/backup_database script. It can be run using yak db backup.
Finally, fastapi needs some configuration to start. Last thing, for development environment, debug needs to be activated with a additional environment variable:
DEBUG=1
And then start backend with:
uvicorn --reload yak_server:create_app --factory
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 .env. It will read data from yak_server/data/{COMPETITION}/.
Testing
Yak-server is using pytest to run tests.
Profiling
You can run the application with profiler attached. To do so, please run the following command
uvicorn --reload scripts.profiling:create_app --factory
1 maintainer
Metadata
1 maintainer
Release files for yak-server 0.94.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| yak_server-0.94.5.tar.gz | 1.4 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yak_server-0.94.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.8 MB
Release files / yak_server-0.94.5.tar.gz
| Download URL | yak_server-0.94.5.tar.gz |
|---|---|
| Size | 1.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eb06a6c169fb67badde75b11e2fd72c0ec56a5a64f766ef8df2710dcf6594932
|
|
BLAKE2b-256 checksum How to use checksums |
658e371cb141dfabeaa15885c403d0bf6ea8502f26a12d980382e51e796b9c38
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / yak_server-0.94.5-py3-none-any.whl
| Download URL | yak_server-0.94.5-py3-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
915b4aa3e3d479542ceb1cf2e3264c77cba3429340ee61869db47de60334a8dc
|
|
BLAKE2b-256 checksum How to use checksums |
a3f73ba4ec7f06d8af428a3d6873ed3f355be6baed2511a319e5857c7aaacf65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logSecurity for yak-server 0.94.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for yak_server-0.94.5.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
