jeremyandress / fastapi-docker

Docker image with FastAPI with users management, ready for production :rocket:

FastAPI Docker 🚀

Features ✨

• FastAPI framework.
• Interactive API documentation
• Full Docker integration.
• Docker Compose integration.
• Production ready Python web server using Uvicorn.
• Secure password hashing by default.
• JWT token authentication.
• SQLAlchemy models
• CORS (Cross Origin Resource Sharing).
• Small utility to paginate SqlAlchemy queries.

Requirements 📌

• Docker 🐳
• docker-compose 🐳
• Python 3.6+ 🐍 To use without docker

Quick Start 🌱

Run FastAPI Docker ⚡ Local Development

1. git clone https://github.com/JeremyAndress/fastapi-docker.git
2. Create .env files cp .env.example .env

You should now have a directory structure like:

.
├── compose
│   ├── local
│   ├── production
│   ├── scripts
│   └── stage
├── nginx
│   └── site.conf
├── requirements
│   ├── local.txt
│   ├── migrations.txt
│   ├── mysql.txt
│   ├── postgre.txt
│   ├── production.txt
│   └── test.txt
├── screenshots
│   └── ui.png
├── src
│   ├── alembic
│   ├── api
│   ├── core
│   ├── db
│   ├── logs
│   ├── models
│   ├── __pycache__
│   ├── schemas
│   ├── tests
│   ├── utils
│   ├── alembic.ini
│   ├── main.py
│   ├── pre_start.py
│   └── prestart.sh
├── CHANGELOG.md
├── LICENSE
├── .env.example
├── .flake8
├── local.yml
├── production.yml
├── pytest.ini
├── README.md
└── stage.yml

3. docker-compose -f local.yml build
4. docker-compose -f local.yml up -d
5. That's just all, api server is listen at http://localhost:8030/docs now

You will see the automatic interactive API documentation (provided by Swagger UI):

Testing 🚨

    pytest -vvs src/tests/

fastapi-docker's Issues

docker-compose -f local.yml build FAILS

Greetings. I successfully fired up your JeremyAndress/FastApi-simple repo. However, this one fails.

Running on Windows 10.

Thank you for any thoughts/suggestions.

`C:__repos\fastapi\fastapi-docker>docker-compose -f local.yml build
WARNING: The POSTGRES_SERVER variable is not set. Defaulting to a blank string.
Building nginx
Step 1/2 : FROM nginx:1.19.1-alpine
---> ecd67fe340f9
Step 2/2 : ADD /nginx/site.conf /etc/nginx/conf.d/default.conf
---> Using cache
---> f7fcc5aec1c4

Successfully built f7fcc5aec1c4
Successfully tagged fastapi-docker_nginx:latest
Building core
Step 1/15 : FROM python:3.6.11-alpine3.11
---> ad9bc7ab5910
Step 2/15 : ARG MYSQL_SERVER
---> Using cache
---> 36de4221a248
Step 3/15 : ARG POSTGRES_SERVER
---> Using cache
---> 5df22b7683aa
Step 4/15 : ENV ENVTYPE=local
---> Using cache
---> 92fa15be7706
Step 5/15 : ENV PYTHONUNBUFFERED 1
---> Using cache
---> 8228a1dc2c1a
Step 6/15 : ENV APP_HOME=/home/app/web
---> Using cache
---> 2a9d3c040655
Step 7/15 : RUN mkdir -p $APP_HOME
---> Using cache
---> 535b4f2e510f
Step 8/15 : WORKDIR $APP_HOME
---> Using cache
---> f4aa7c807743
Step 9/15 : ADD /compose/scripts.sh $APP_HOME
---> Using cache
---> 0c7aa2627ec4
Step 10/15 : ADD /requirements/$ENVTYPE.txt $APP_HOME
---> Using cache
---> 049bf14f50ed
Step 11/15 : RUN chmod +x scripts.sh
---> Using cache
---> 5b684b5ca32e
Step 12/15 : RUN ./scripts.sh
---> Running in 1c341fe2de08
fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/main/x86_64/APKINDEX.tar.gz
fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/community/x86_64/APKINDEX.tar.gz
ERROR: unsatisfiable constraints:
(missing):
] required by: world[tzdata
fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/main/x86_64/APKINDEX.tar.gz
fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/community/x86_64/APKINDEX.tar.gz
v3.11.7-19-gd6a090b561 [http://dl-cdn.alpinelinux.org/alpine/v3.11/main]
v3.11.7 [http://dl-cdn.alpinelinux.org/alpine/v3.11/community]
OK: 11277 distinct packages available
fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/main/x86_64/APKINDEX.tar.gz
fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/community/x86_64/APKINDEX.tar.gz
ERROR: unsatisfiable constraints:
(missing):
] required by: world[
: not foundh: line 5: python3-dev
./scripts.sh: line 11: syntax error: unexpected "elif" (expecting "then")
ERROR: Service 'core' failed to build : The command '/bin/sh -c ./scripts.sh' returned a non-zero code: 2

`