Metadata-Version: 1.1
Name: Flask-Restler
Version: 1.0.3
Summary: Build REST API for Flask using Marshmallow.
Home-page: https://github.com/klen/flask-restler
Author: Kirill Klenov
Author-email: horneds@gmail.com
License: MIT
Description: The Flask RESTler
        #################
        
        .. _badges:
        
        .. image:: http://img.shields.io/travis/klen/falsk-restler.svg?style=flat-square
            :target: http://travis-ci.org/klen/falsk-restler
            :alt: Build Status
        
        .. image:: http://img.shields.io/pypi/v/flask-restler.svg?style=flat-square
            :target: https://pypi.python.org/pypi/flask-restler
            :alt: Version
        
        .. image:: http://img.shields.io/pypi/dm/flask-restler.svg?style=flat-square
            :target: https://pypi.python.org/pypi/flask-restler
            :alt: Downloads
        
        .. _description:
        
        The Flask RESTler -- Build REST API for Flask_ using Marshmallow_.
        
        Has builded support for SQLAlchemy_, Peewee_ ORM and Pymongo_.
        
        Example "Hello User" with the Flask-resler:
        
        .. code-block:: python
        
            from flask_restler import Api, Resource
        
        
            # flask_restler.Api is subclass of Flask.Blueprint
            api = Api('My awesome API', __name__, url_prefix='/api/v1')
        
            # flask_restler.Resource is subclass of Flask.views.View
            @api.connect
            class HelloResource(Resource):
        
                def get(self, resource=None):
                    return 'Hello World!'
        
        
            # Regiater with your application
            from your_project import app
        
            app.register_blueprint(api)
        
            if __name__ == '__main__':
                app.run()
        
        
        Run the application and open http://localhost:5000/api/v1/ in your browser.
        
        
        .. _contents:
        
        .. contents::
        
        Requirements
        =============
        
        - python 2.7+,3.4+
        
        .. _installation:
        
        Installation
        =============
        
        **Flask-RESTler** should be installed using pip: ::
        
            pip install flask-restler
        
        .. _usage:
        
        Usage
        =====
        
        Docs in progress. Would like to help? Create a PR.
        
        
        .. _bugtracker:
        
        Bug tracker
        ===========
        
        If you have any suggestions, bug reports or
        annoyances please report them to the issue tracker
        at https://github.com/klen/flask-restler/issues
        
        .. _contributing:
        
        Contributing
        ============
        
        Development of The Flask-restler happens at: https://github.com/klen/flask-restler
        
        
        Contributors
        =============
        
        * `Kirill Klenov <https://github.com/klen>`_
        
        .. _license:
        
        License
        ========
        
        Licensed under a MIT license (See LICENSE)
        
        If you wish to express your appreciation for the project, you are welcome to
        send a postcard to: ::
        
            Kirill Klenov
            pos. Severny 8-3
            MO, Istra, 143500
            Russia
        
        .. _links:
        
        .. _klen: https://github.com/klen
        .. _Flask: http://flask.pocoo.org/
        .. _Marshmallow: https://marshmallow.readthedocs.org/en/latest/
        .. _Peewee: http://docs.peewee-orm.com/en/latest/
        .. _SQLAlchemy: http://www.sqlalchemy.org/
        .. _Pymongo: https://api.mongodb.com/python/current/
        
Keywords: flask,marshmallow,rest,api
Platform: Any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Natural Language :: Russian
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
