Welcome to Madame

Release v0.1.2. (Installation)

Welcome to Madame’s documentation. Madame is a RESTful API for MongoDB built on Flask. It is highly customizable and easy to use and to configure.

from madame import Madame

app = Madame()
app.run()

Madame depends on two main libraries: the Flask microframework and the Validictory data validator. These libraries are not documented here. If you want to dive into their documentation, check out the following links:

• Flask documentation
• Validictory documentation

User’s Guide

• Introduction
  • Features
  • License
  • Authors
• Installation
  • Pip and easy_install
  • Source Code
• Usage
  • Prerequisites
  • Basic usage
• Tutorial
  • The goal
  • Step 1 - The folders
  • Step 2 - The configuration
  • Step 3 - The Database Schema
  • Step 4 - The methods allowed
  • Step 5 - The server
  • Examples
• Configuration Handling
  • The configuration file
  • Builtin configuration values
• Schemas
  • The schema file
  • Adding schemas with POST
  • Schema example