Datastore API

API service for a microdata.no datastore.

Development

Get started

After cloning the repo, install and activate an environment with:

uv venv && uv sync && source .venv/bin/activate 

Running the test suite

To run the unit and integration tests:

uv run pytest

Running the application

You can run the application locally with hot reloading:

DOCKER_HOST_NAME=localhost \
STACK=dev \
COMMIT_ID=abc123 \
SQLITE_URL=test.db \
JWT_AUTH=OFF \
JWKS_URL=http://localhost \
SECRETS_FILE=tests/resources/secrets/secrets.json \
DATASTORES_ROOT_DIR=tests/resources \
uv run python datastore_api/main.py

Migrations

The application uses file-based SQLite migrations to manage schema changes. Migrations are executed on application startup.

Rules

• Migration filenames must start with a valid calendar date (YYYYMMDD) and be placed within the /migrations directory.
• Migration dates must be newer than the date of the last applied migration.
• Each migration file is executed once.
• Applied migrations are tracked in the migrations table.
• If a previously applied migration file is modified (hash mismatch), startup will fail.

Pre-commit

There are currently 3 active rules: Ruff-format, Ruff-lint and sync lock file. Install pre-commit

pip install pre-commit

If you've made changes to the pre-commit-config.yaml or its a new project install the hooks with:

pre-commit install

Now it should run when you do:

git commit

By default it only runs against changed files. To force the hooks to run against all files:

pre-commit run --all-files

if you dont have it installed on your system you can use: (but then it wont run when you use the git-cli)

uv run pre-commit

Read more about pre-commit

Built with

• FastAPI
• Uvicorn
• Gunicorn
• uv