backend

Intro

This is a asgi - starlette demo project.

What's asgi? In short, the successor to wsgi!

It features:

• starlette asgi framework
• uvicorn asgi server
• gunicorn http server
• poetry dependency manager
• databases async db support
• sqlalchemy sql toolkit
• alembic database migrations
• black code formatter
• flake8 style checker
• mypy static type checker
• xenon cyclomatic complexity checker
• pytest test framework

and:

• a Dockerfile for simple deployment
• a travis config for continuous integration

Development

Setup Poetry

Using poetry for project dependency management

# make sure poetry is installed
$ which poetry
/usr/local/bin/poetry

# how I setup poetry
$ poetry config settings.virtualenvs.create false
$ poetry config settings.virtualenvs.in-project true 

$ poetry config --list                               
settings.virtualenvs.create = false
settings.virtualenvs.in-project = true

Install Dependencies

# create venv
$ python3.7 -m venv .venv
$ source venv/bin/activate

# install project dependencies
$ poetry install

Setup Environment

# .env for development
$ ln -s .env.dev .env

Code Formatting

$ balck app tests
All done! ✨ 🍰 ✨
18 files left unchanged.

$ black app tests --check # this one is for CI

Import Sorting

$ isort -rc app tests

$ isort -rc app tests --check-only # this one is for CI

Lint Checks

$ flake8 app tests

Type Checks

$ mypy app tests

Cyclomatic Complexity

$ radon cc app -n B -s
$ radon cc tests -n B -s

$ xenon app -b A # this one is for CI
$ xenon tests -b A # this one is for CI

Run Tests

$ pytest

# for ipdb compatibale test runs
$ pytest -s

# for detailed coverage report
$ coverage html
$ firefox htmlcov/index.html

Run DB migrations

$ alembic upgrade head
...
INFO  [alembic.runtime.migration] Running upgrade  -> 8a4192a2406a, create protocols table
INFO  [alembic.runtime.migration] Running upgrade 8a4192a2406a -> 1a9952031305, update protocols table: is_cool col
...

$ alembic revision --autogenerate -m "update protocols table: add example col"
...
INFO  [alembic.autogenerate.compare] Detected added column 'protocols.example'
...

Run Dev Server

# run asgi server with auto load
$ ./dev.sh