Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #9

Merged
merged 1 commit into from
Sep 16, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@
Template application for a basic Flask API.

This application should run as-is with minimal setup (see below).

## Features

- Python/Flask-based API that writes to a database using API key authentication with example endpoints
- PostgreSQL database + Alembic migrations configured for updating the database when the SQLAlchemy database models are updated
- Thorough formatting & linting tools
- Logging, with formatting in both human-readable and JSON formats
- Backend script that generates a CSV locally or on S3 with proper credentials
- Ability to run the various utility scripts inside or outside of Docker
- Restructured and improved API request and response error handling which gives more details than the out-of-the-box approach for both Connexion and Pydantic
- Easy environment variable configuration for local development using a `local.env` file

See [docs/README.md](/docs/README.md) for details on the API implementation.

## Getting started

This application is dockerized. Take a look at [Dockerfile](./app/Dockerfile) to see how it works.
Expand All @@ -17,5 +31,3 @@ A very simple [docker-compose.yml](./docker-compose.yml) has been included to su
4. Navigate to `localhost:8080/v1/docs` to access the Swagger UI.
5. Run `make run-logs` to see the logs of the running API container
6. Run `make stop` when you are done to delete the container.

See: [app/README.md](/app/README.md) for further details on the API implementation.