Flask Boilerplate

screenshot of Flask Boilerplate

Overview:

This boilerplate code is a skeleton for a flask application designed for building RESTful APIs using HTTP and JSON in Python 3. It has been tested with Python 3.6. The code provides a decent general structure and includes features such as production and development configurations, clevercloud structure for easy deployment, Rollbar integration for error tracking, and endpoint documentation using flask-restplus. It is also CORS ready and supports JSON logging on the stdout and logentries.

Features:

  • Decent general structure: Provides a well-organized structure for building Flask applications.
  • Prod/Dev configuration in the environment: Allows easy switching between production and development environments by setting environment variables.
  • Clevercloud structure, deployment ready: Designed to work seamlessly with the clevercloud platform for easy deployment.
  • Rollbar integration: Integration with Rollbar for error tracking and monitoring.
  • Endpoint documented with flask-restplus: Allows easy documentation of API endpoints using the flask-restplus library.
  • CORS ready: Supports Cross-Origin Resource Sharing (CORS) for handling requests from different domains.
  • JSON logging on the stdout and logentries: Logs messages in JSON format to the stdout and logentries for easy debugging and monitoring.

Summary:

This flask application boilerplate provides a solid foundation for building RESTful APIs using Flask and Python 3. It offers a well-organized structure, supports different environments, integrates with external services like Rollbar and logentries, and provides convenient features for testing, code quality checking, and logging. The installation process is straightforward, and the project is well-documented, making it easy to get started with building your own Flask applications. The code is licensed under the MIT License, allowing you to freely use and modify it for your own purposes.