Flask-Diamond¶
Flask-Diamond is a batteries-included Python Flask framework, sortof like Django but radically decomposable. Flask-Diamond offers some opinions about network information systems that process data. Using Flask-Diamond, you can scaffold a working application with sensible defaults, then easily override those defaults to meet your own goals. Flask-Diamond provides a shared vocabulary that helps teams coordinate as they scale up to develop multiple Flask applications while maintaining good code reuse and learning transfer. Flask-Diamond goes beyond a “project scaffold” by providing a complete architecture and team solution, including documentation, tutorials, and other learning support.
Overview¶
A Flask-Diamond application consists of facets, which are common facilities that many applications eventually need to provide. The facets provided by Flask-Diamond include:
- account management
- administrative access
- databases
- Model object CRUD
- testing
- documentation
- deployment
- and more
Usage¶
The following steps will create a new Flask-Diamond application.
pip install Flask-Diamond
mkdir my-application
cd my-application
flask-diamond scaffold app
make install docs test db server
Please read the Introduction Documentation to get started.
Usage on Windows¶
The following steps will create a new Flask-Diamond application on a Windows machine.
easy_install -U mr.bob==0.1.2
pip install Flask-Diamond
md my-application
cd my-application
flask-diamond scaffold app
make install db-win server-win
Documentation¶
Get Started¶
Start here. These introductory readings will teach you how to install Flask-Diamond and how to read the rest of the Flask-Diamond documentation.
Basics¶
Learn how to create a new project. This section introduces the Flask-Diamond philosophy and the first steps for making an application.
Developers Guide¶
Learn common development patterns.
Facets Guide¶
This section describes the facets of Flask-Diamond.
Operation Guide¶
The User Guide topics are for managing and installing a Flask-Diamond application. In particular, IT Ops and Deployment Engineers will benefit from this section.