Repository template for using flask as a restful API.
- Web development framework with flask
- Simple API building with flask-restful
- Input validation with jsonschema
- Dependency management with poetry
- Testing with pytest
- Job scheduling with RQ
- Configuration management with dynaconf
- Logging with loguru
- Database with MongoDB and pymongo
- Caching with Redis and python-redis
- Easy development with docker-compose
- Build pipeline already established for exporting a docker image.
- Github Actions set up to run Continuous Integration
- Development task automation with doit
- 100% Test coverage, including unit and end to end testing
- Sample Todo app, showcasing how to use the template
Make sure you have, poetry, docker and docker-compose installed and run
the following:
$ poetry install
...
$ poetry run doit bootstrap --name my-application-name
...
$ docker-compose up
Open localhost:5000/hello, you should be seeing
["Hello", "Flask", "Template!"].
$ poetry run doit test
$ docker-compose up
... in another terminal ...
$ poetry run doit e2e