Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandre committed Oct 27, 2015
1 parent e8c8820 commit 87df460
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 87df460

Please sign in to comment.