Flask Rest Template

screenshot of Flask Rest Template
flask

Flask Rest Template

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

Overview:

This project is a Flask REST Template that aims to provide a useful and simple template for a REST app. The project follows best practices and includes helpful docstrings and helper functions. It uses pytest for testing instead of the default unittest module. The project is written in Python 3.4.x and includes a complete CRUD module as an example structure. The main requirements include Flask-MongoEngine, Flask-JWT, and Flask-Restful. Collaboration is welcome to improve tests and coverage, update third-party library usage, and more. The project is licensed under public domain.

Features:

  • Complete CRUD module for demonstration purposes
  • Use of passlib to generate hashes as an example
  • Testing with pytest, pytest-cov, and pylama
  • Potential to use an alternative to MongoEngine + MongoDB, such as SQLAlchemy + PostgreSQL

Installation:

To install the Flask REST Template, follow these steps:

  1. Clone the repository: git clone https://github.com/<repository-url>
  2. Change into the project directory: cd <project-directory>
  3. Install the required dependencies: pip install -r requirements.txt

Summary:

The Flask REST Template is a useful and simple template for creating REST apps. It includes a complete CRUD module and uses pytest for testing. The project is written in Python 3.4.x and requires Flask-MongoEngine, Flask-JWT, and Flask-Restful. Collaboration is encouraged to improve the project and add new features. The project is licensed under public domain.

flask
Flask

Flask is a lightweight and popular web framework for Python, known for its simplicity and flexibility. It is widely used to build web applications, providing a minimalistic approach to web development with features like routing, templates, and support for extensions.

template
Templates & Themes

A template or theme refers to a pre-designed layout or structure that provides a basic framework for building a specific type of application or website. It typically includes good design, placeholder content and functional features, allowing developers to customize and fill in the details according to their specific needs.