stellar

Installation

• using virtualenv virtualenv --python=3.8 venv pip install -r requirements.txt
• using pipenv pipenv --python 3.8 pipenv install --dev

Running tests

• with virtualenv
  • activate virtual environment: source venv/bin/activate
• with pipenv
  • activate virtual environment: pipenv shell
• pytest tests

Running with Docker Compose

• start API + PostgreSQL
  • docker compose up --build
• API is available on http://localhost:9000
• stop stack
  • docker compose down
• stop stack and remove database volume
  • docker compose down -v

API Documentation (Swagger UI)

• Open Swagger UI at http://localhost:9000/api/docs
• Open raw OpenAPI spec at http://localhost:9000/api/openapi.json

Update OpenAPI Schema File

• Generate a schema file that matches the current Flask routes:
  • python update_openapi_schema.py --routes-root app/web/api --app-web-root app/web --output app/web/api/openapi.generated.json