Name		Name	Last commit message	Last commit date
parent directory ..
app		app
contrib		contrib
env_tests		env_tests
tests		tests
.dockerignore		.dockerignore
.env.tests.local.example		.env.tests.local.example
.gitignore		.gitignore
Dockerfile		Dockerfile
Makefile		Makefile
README.md		README.md
compose.test-env.yaml		compose.test-env.yaml
conftest.py		conftest.py
main.py		main.py
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
run_test.sh		run_test.sh
update-commit-hash.sh		update-commit-hash.sh
update-version.sh		update-version.sh

README.md

aidbox-python-sdk-example

Development

Local environment setup

Install pyenv and poetry globally
Install python3.12 python globally using pyenv
Inside the app directory, run poetry env use /path/to/python312
Run poetry install
Run poetry shell to activate virtual environment
Run autohooks activate to activate git hooks

Testing

Run cp .env.tests.local.example .env.tests.local
Put your dev aidbox license key into AIDBOX_LICENSE_TEST in .env.tests.local
Run make build-test at the first time and every time once dependencies are updated/added
Run make run-test
You can kill the containers when complete to work with tests by run: make down-test

IDE setup

Strongly recommended to use ruff and mypy plugins for IDE