new version 1

Author: rafsaf

.gitignore

@@ -0,0 +1 @@
+.vscode

README.md

@@ -1,4 +1,6 @@
-# Full featured FastAPI template, all boring and tedious things are covered
+## Small FastAPI template, all boring and tedious things covered
+
+![OpenAPIexample](./docs/OpenAPI_example.png)
 
 - SQLAlchemy using new 2.0 API + async queries
 - Postgresql database under `asyncpg`
@@ -10,10 +12,18 @@
 - `pre-push.sh` script with poetry export, autoflake, black, isort and flake8
 - Setup for tests, one big test for token flow and very extensible `conftest.py`
 
-# Quickstart
+## What this repo is
+
+This is a minimal template for FastAPI backend + postgresql db as of 2021, `async` style for database sessions, endpoints and tests. It provides basic codebase that almost every application has, but nothing more.
+
+## What this repo is not
+
+It is not complex, full featured solutions for all human kind problems. It doesn't include any third party that isn't necessary for most of apps (dashboards, queues) or implementation differs so much in every project that it's pointless (complex user model, emails).
+
+## Quickstart
 
 ```bash
-# You can install it globally
+# You can even install it globally
 pip install cookiecutter
 
 # And cookiecutter this project :)
@@ -38,8 +48,12 @@ pytest
 # in official template
 ```
 
-# About
+## About
 
 This project is heavily base on official template https://github.com/tiangolo/full-stack-fastapi-postgresql (and on my previous work: [link1](https://github.com/rafsaf/fastapi-plan), [link2](https://github.com/rafsaf/docker-fastapi-projects)), but as it is now not too much up-to-date, it is much easier to create new one than change official. I didn't like some of conventions over there also (`crud` and `db` folders for example).
 
-`2.0` style SQLAlchemy API is good enough so there is no need to write everything in `crud` and waste our time... The `core` folder was also rewritten. There is great base for writting tests in `tests`, but I didn't want to write hundreds of them, I noticed that usually after changes in the structure of the project, auto tests are useless and you have to write them from scratch, hence less than more. Similarly with the `User` model, it is very modest, because it will be adapted to the project anyway (and there are no tests for these endpoints)
+`2.0` style SQLAlchemy API is good enough so there is no need to write everything in `crud` and waste our time... The `core` folder was also rewritten. There is great base for writting tests in `tests`, but I didn't want to write hundreds of them, I noticed that usually after changes in the structure of the project, auto tests are useless and you have to write them from scratch anyway (delete old ones...), hence less than more. Similarly with the `User` model, it is very modest, because it will be adapted to the project anyway (and there are no tests for these endpoints, you would remove them probably).
+
+## Learn by example
+
+Let's imagine we need to create API for a website where users brag about their dogs... or whatever, they just can crud dogs in user panel for some reason. We will add dummy model Dog to our API, with relation to the default table User and crud auth endpoints, then test it shortly.

docs/OpenAPI_example.png

@@ -1,19 +1,15 @@
 DEBUG=true
 SECRET_KEY=string
 ACCESS_TOKEN_EXPIRE_MINUTES=11520
+REFRESH_TOKEN_EXPIRE_MINUTES=40320
 
-
-VERSION="0.1.0"
-DESCRIPTION=string
-PROJECT_NAME=string
-API_STR=
 BACKEND_CORS_ORIGINS=http://localhost:3000,http://localhost:8001
 
-POSTGRES_USER=postgres
-POSTGRES_PASSWORD=strong_password
+DEFAULT_DATABASE_USER=postgres
+DEFAULT_DATABASE_PASSWORD=strong_password
 POSTGRES_SERVER=db
-POSTGRES_DB=db
-POSTGRES_PORT=4999
+DEFAULT_DATABASE_DB=db
+DEFAULT_DATABASE_PORT=4999
 
 FIRST_SUPERUSER_EMAIL=example@example.com
 FIRST_SUPERUSER_PASSWORD=string_password

{{cookiecutter.project_name}}/.env.example

@@ -1,19 +1,42 @@
 DEBUG=true
 SECRET_KEY="{{ random_ascii_string(50) }}"
 ACCESS_TOKEN_EXPIRE_MINUTES=11520
+REFRESH_TOKEN_EXPIRE_MINUTES=40320
 
-
-VERSION="0.1.0"
-DESCRIPTION="{{ cookiecutter.project_name }}"
-PROJECT_NAME="{{ cookiecutter.project_name }}"
-API_STR=
 BACKEND_CORS_ORIGINS=http://localhost:3000,http://localhost:8001
 
-POSTGRES_USER=postgres
-POSTGRES_PASSWORD="{{ random_ascii_string(50) }}"
+DEFAULT_DATABASE_USER="{{ random_ascii_string(10) }}"
+DEFAULT_DATABASE_PASSWORD="{{ random_ascii_string(50) }}"
 POSTGRES_SERVER=db
-POSTGRES_DB=db
-POSTGRES_PORT=4999
+DEFAULT_DATABASE_DB=db
+DEFAULT_DATABASE_PORT=4999
 
 FIRST_SUPERUSER_EMAIL=example@example.com
 FIRST_SUPERUSER_PASSWORD="{{ random_ascii_string(20) }}"
+
+
+
+SECRET_KEY="{{ random_ascii_string(50) }}"
+ENVIRONMENT="DEV"
+ACCESS_TOKEN_EXPIRE_MINUTES=11520
+REFRESH_TOKEN_EXPIRE_MINUTES=40320
+BACKEND_CORS_ORIGINS=http://localhost:3000,http://localhost:8001
+
+DEFAULT_DATABASE_HOSTNAME=localhost
+DEFAULT_DATABASE_USER="{{ random_ascii_string(10) }}"
+DEFAULT_DATABASE_PASSWORD="{{ random_ascii_string(50) }}"
+DEFAULT_DATABASE_PORT={{ range(4000, 7000) | random }}
+DEFAULT_DATABASE_DB: str
+DEFAULT_SQLALCHEMY_DATABASE_URI: str = ""
+
+# POSTGRESQL TEST DATABASE
+TEST_DATABASE_HOSTNAME: str
+TEST_DATABASE_USER: str
+TEST_DATABASE_PASSWORD: str
+TEST_DATABASE_PORT = {{ range(30000, 40000) | random }}
+TEST_DATABASE_DB: str
+TEST_SQLALCHEMY_DATABASE_URI: str = ""
+
+# FIRST SUPERUSER
+FIRST_SUPERUSER_EMAIL: EmailStr
+FIRST_SUPERUSER_PASSWORD: str

{{cookiecutter.project_name}}/.env.template

@@ -5,10 +5,7 @@ ignore = E203, E501, W503
 exclude = 
     __init__.py,
     .venv,
+    venv,
     __pycache__,
     .github,
     .vscode,
-    config,
-    locale,
-    webhook
-    app/tests/conftest.py

{{cookiecutter.project_name}}/.flake8

@@ -1,23 +1,23 @@
+# See https://hub.docker.com/r/nginx/unit/
 FROM nginx/unit:1.25.0-python3.9
 
-# Our Debian with Python and Nginx for python apps.
-# See https://hub.docker.com/r/nginx/unit/
 ENV PYTHONUNBUFFERED 1
 
-COPY ./app/initial.sh /docker-entrypoint.d/initial.sh
-COPY ./config/config.json /docker-entrypoint.d/config.json
+# Nginx unit config and init.sh will be used at container startup
+COPY ./app/init.sh /docker-entrypoint.d/init.sh
+COPY ./nginx-unit-config.json /docker-entrypoint.d/config.json
+RUN chmod +x /docker-entrypoint.d/init.sh
 
+# Build folder for our app, only stuff that matters copied.
 RUN mkdir build
-
-# We create folder named build for our app.
 WORKDIR /build
 
 COPY ./app ./app
+COPY ./alembic ./alembic
 COPY ./alembic.ini .
 COPY ./requirements.txt .
 
-# We copy our app folder to the /build
-
+# Requirements and then cleanup
 RUN apt update && apt install -y python3-pip                                  \
     && pip3 install -r requirements.txt                                       \
     && apt remove -y python3-pip                                              \

{{cookiecutter.project_name}}/Dockerfile

@@ -31,7 +31,9 @@
 
 
 def get_database_uri():
-    return settings.SQLALCHEMY_DATABASE_URI
+    if settings.ENVIRONMENT == "PYTEST":
+        return settings.TEST_SQLALCHEMY_DATABASE_URI
+    return settings.DEFAULT_SQLALCHEMY_DATABASE_URI
 
 
 def run_migrations_offline():
@@ -52,14 +54,17 @@ def run_migrations_offline():
         target_metadata=target_metadata,
         literal_binds=True,
         dialect_opts={"paramstyle": "named"},
+        compare_type=True,
     )
 
     with context.begin_transaction():
         context.run_migrations()
 
 
 def do_run_migrations(connection):
-    context.configure(connection=connection, target_metadata=target_metadata)
+    context.configure(
+        connection=connection, target_metadata=target_metadata, compare_type=True
+    )
 
     with context.begin_transaction():
         context.run_migrations()

{{cookiecutter.project_name}}/alembic/env.py

@@ -13,7 +13,7 @@
 from app.models import User
 from app.session import async_session
 
-reusable_oauth2 = OAuth2PasswordBearer(tokenUrl=f"{settings.API_STR}/auth/access-token")
+reusable_oauth2 = OAuth2PasswordBearer(tokenUrl="/auth/access-token")
 
 
 async def get_session() -> AsyncGenerator[AsyncSession, None]:

{{cookiecutter.project_name}}/app/api/deps.py

@@ -29,7 +29,7 @@ async def login_access_token(
     if user is None:
         raise HTTPException(status_code=400, detail="Incorrect email or password")
 
-    if not security.verify_password(form_data.password, user.hashed_password):
+    if not security.verify_password(form_data.password, user.hashed_password):  # type: ignore
         raise HTTPException(status_code=400, detail="Incorrect email or password")
 
     access_token, expire_at = security.create_access_token(user.id)