https://github.com/alexandre-old/flask-rest-template

template for a rest app with flask, flask-rest and more...
https://github.com/alexandre-old/flask-rest-template

blueprints boilerplate flask flask-application public-domain python rest template

Last synced: 3 months ago
JSON representation

template for a rest app with flask, flask-rest and more...

• Host: GitHub
• URL: https://github.com/alexandre-old/flask-rest-template
• Owner: alexandre-old
• License: unlicense
• Created: 2015-01-31T05:26:17.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-11-16T23:06:43.000Z (about 2 years ago)
• Last Synced: 2024-06-17T05:30:49.490Z (7 months ago)
• Topics: blueprints, boilerplate, flask, flask-application, public-domain, python, rest, template
• Language: Python
• Homepage:
• Size: 82 KB
• Stars: 109
• Watchers: 2
• Forks: 22
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-flask - flask-rest-template
• jimsghstars - alexandre-old/flask-rest-template - template for a rest app with flask, flask-rest and more... (Python)

README

        
# Flask REST Template

[![Code Health](https://landscape.io/github/alexandre/flask-rest-template/master/landscape.svg?style=flat)](https://landscape.io/github/alexandre/flask-rest-template/master) 

[![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 (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

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:

It's a __public domain__ project. =]

# About the inspirations:

* Ideas and answers >> #pocoo IRC channel;

* cookiecutter-flask;

* Flask Snippets;

* Flask-restful-example;

* [What the Flask](http://pythonclub.com.br/tag/what-the-flask.html) a tutorial in portuguese by [Bruno Rocha](https://github.com/rochacbruno)

* Flaskbook by [Miguel Grinberg](https://github.com/miguelgrinberg)

* Some questions in Stack Overflow or tweets that I don't have a link. =P