python-rest-template

A clean Python template for your next REST projects.

Features

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

You need to install Pipenv in your machine.

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

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 .

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.

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

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

Name		Name	Last commit message	Last commit date
Latest commit History 21 Commits
.github		.github
.vscode		.vscode
alembic		alembic
app		app
locales		locales
tests		tests
.editorconfig		.editorconfig
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
LICENSE		LICENSE
Pipfile		Pipfile
Pipfile.lock		Pipfile.lock
README.md		README.md
alembic.ini.example		alembic.ini.example
config.yaml.example		config.yaml.example
extract_messages.sh		extract_messages.sh
main.py		main.py
mypy.ini		mypy.ini
pytest.ini		pytest.ini
sample-api.png		sample-api.png
update_translation.sh		update_translation.sh