From 87df460d99753081d133d11fb9a2b5093bf8481d Mon Sep 17 00:00:00 2001 From: Alexandre Date: Tue, 27 Oct 2015 14:19:50 -0200 Subject: [PATCH] Update README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4605cc8..5132982 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,50 @@ [![Build Status](https://travis-ci.org/alexandre/flask-rest-template.svg)](https://travis-ci.org/alexandre/flask-rest-template) [![Coverage Status](https://coveralls.io/repos/alexandre/flask-rest-template/badge.svg?branch=master)](https://coveralls.io/r/alexandre/flask-rest-template?branch=master) -# About the project: +# About the project (some comments): + +The ideia behind the project is to create an useful and simple template for an rest app . Besides the good intentions, I tried to follow some ideas that I've learned. (see "inspirations" item). + +I also tried to create useful docstrings and helpers functions. However, I did not create (yet) a documentation based on docstring (e.g. using sphinx), what [IMO] could give an idea about write docs. + +Instead to use the default (from stdlib) unittest module, I prefer to use pytest. I hope it can be useful and nice. + ## Python version + +__Python 3.4.x__ + ## The module users + +This module is a complete CRUD as an example of structure to facilitate a demonstration about write tests (unit and +integration). In this mock, I used passlib to generate hashs, but just as an example... + ## Flask extensions and other components + +### Main requirements +* Flask-MongoEngine +* Flask-JWT +* Flask-Restful +* uWSGI + +### Testing requirements +* Pytest +* pytest-cov +* pylama + ## Alternative to MongoEngine + MongoDB + +It's a possible issue/to-do. Create a branch using something like sqlalchemy + postgres... + ## How to collaborate -## Others projects/ideas using this "template" + +There is a lot of things to do: + +* Improving tests and coverage +* Updating the use of third party libs +* Improving this README.md +* Reporting an issue (typo, RFC, other kind of mistake/error) +* Adding a python2 support ( I did not verify it yet) +* and etc # About the license: