python-rest-template

A clean Python template for your next REST projects.

Features

• Scalable folder structure
• Consistent style, be productive with useful pre-commit hooks
• i18n support

Sample App

This repo contains a demo for a chat app. You can create threads, messages. Here are all APIs in the repo:

Setup

You need to install Pipenv in your machine.

pipenv shell
pipenv install
pipenv install --dev
pre-commit install # install pre-commit hooks

Run app

cp config.yaml.example config.yaml
# update your app config in config.yaml
pipenv run app

Now, you can check API docs located at http://localhost:8000/docs .

Test apps

pipenv run test

To show code coverage, just run:

pipenv run test-cov

In order to show code coverage in VsCode, you will need to install Coverage Gutters extension.

Database migration

cp alembic.ini.example alembic.ini
# update alembic.ini config file
alembic upgrade head

Error code localization with i18n

./extract_messages.sh
# update your translation in `base.po` files
./update_translation.sh

License

MIT