Metadata-Version: 2.0
Name: Flask-DStore
Version: 0.1.2
Summary: DStore Web API and JS Client using FLask
Home-page: https://github.com/MarkLark/flask-dstore
Author: Mark Pittaway
Author-email: mark.pittaway@mlit.net.au
License: MIT
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Database :: Front-Ends
Requires-Dist: Flask (>=0.10)
Requires-Dist: dstore (>=0.1.1)
Requires-Dist: dstore-acl (>=0.1.1)

Welcome To DStore
#################

.. image:: https://img.shields.io/coveralls/MarkLark/flask-dstore.svg
    :target: https://coveralls.io/github/MarkLark/flask-dstore?branch=master

.. image:: https://img.shields.io/travis/MarkLark/flask-dstore/master.svg
    :target: https://travis-ci.org/MarkLark/flask-dstore

.. image:: https://img.shields.io/pypi/v/flask-dstore.svg
    :target: https://pypi.python.org/pypi/flask-dstore

.. image:: https://img.shields.io/pypi/pyversions/flask-dstore.svg
    :target: https://pypi.python.org/pypi/flask-dstore

Flask-DStore is a Web API and Javascript Client.
The API routes, logic and client code is automatically generated for you.


Installing
==========

PyMan is available from the PyPi repository.

This means that all you have to do to install PyMan is run the following in a console:

.. code-block:: console

    $ pip install dstore-flask

Minimal Example
===============

.. code-block:: python

    from flask import Flask
    from dstore import MemoryStore, Model, var, mod
    from flask_dstore import API

    class Car( Model ):
        _namespace = "cars.make"
        _vars = [
            var.RowID,
            var.String( "manufacturer", 32, mods = [ mod.NotNull() ] ),
            var.String( "make", 32, mods = [ mod.NotNull() ] ),
            var.Number( "year", mods = [ mod.NotNull(), mod.Min( 1950 ), mod.Max( 2017 ) ] ),
        ]

    # Create the app instances
    app = Flask( __name__ )
    store = MemoryStore( [ Car ] )
    api = API( store, app )

    # While inside the Flask app context, create all storage and add a car
    with app.app_context():
        store.create_all()
        Car( manufacturer = "Holden", make = "Commodore", year = 2005 ).add()

    # Run the Flask dev. server
    app.run()

    # Now destroy all data
    with app.app_context():
        store.destroy_all()

    store.destroy_app()


Documentation: `ReadTheDocs <http://flask-dstore.readthedocs.io/>`_

Source Code: `GitHub <https://github.com/MarkLark/flask-dstore>`_