Overview

A simple API implemented using FastAPI, SQLModel and a Postgresql container for storing data.

Project configuration is stored in config.yml file inside the project root directory.

Project Setup for Development

1. Install dependencies

pip install -r requirements.txt

2. Create a config.yml file (copying config.yml.example should be enough)

3. Run a database container

python app/db/container.py run

4. Apply database migrations

python app/db/db_setup.py upgrade

5. Start a development server

fastapi dev app/main.py

Running Tests

Overview

Test cases are implemented with Pytest. Some test cases use the Postgresql container for creating temporary databases.

Run Tests via "tests" Module

# Run all test cases
python -m tests

# Run specific test files with additional pytest args
python -m tests path/relative/to/tests/tests [<additional pytest args>]

Run a Test File Directly

python path/to/test/file

Other

Postgresql Container Management

# Run or start the container
python app/db/container.py run

# Stop the container
python app/db/container.py stop

# Remove the container with data
python app/db/container.py remove

Development Database Management

# Create a new Alembic revision
python app/db/db_setup.py revision <revision_message>

# Upgrade development database to a revision (to head, if revision is omitted)
python app/db/db_setup.py upgrade [<revision>]

# Downgrade development database to a revision (to base, if revision is omitted)
python app/db/db_setup.py downgrade [<revision>]