Metadata-Version: 2.0
Name: flask-fs
Version: 0.1
Summary: Simple and easy file storages for Flask
Home-page: https://github.com/noirbizarre/flask-fs
Author: Axel Haustant
Author-email: noirbizarre@gmail.com
License: MIT
Download-URL: http://pypi.python.org/pypi/flask-fs
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Environment :: Web Environment
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Software Distribution
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: flask
Requires-Dist: six
Provides-Extra: test
Requires-Dist: nose; extra == 'test'
Requires-Dist: rednose; extra == 'test'
Requires-Dist: mock; extra == 'test'
Requires-Dist: flask-mongoengine; extra == 'test'
Requires-Dist: pillow; extra == 'test'
Requires-Dist: boto; extra == 'test'
Requires-Dist: python-swiftclient; extra == 'test'
Requires-Dist: pymongo; extra == 'test'
Provides-Extra: s3
Requires-Dist: boto; extra == 's3'
Provides-Extra: all
Requires-Dist: boto; extra == 'all'
Requires-Dist: python-swiftclient; extra == 'all'
Requires-Dist: pymongo; extra == 'all'
Provides-Extra: swift
Requires-Dist: python-swiftclient; extra == 'swift'
Provides-Extra: gridfs
Requires-Dist: pymongo; extra == 'gridfs'

========
Flask-FS
========














Simple and easy file storages for Flask


Compatibility
=============

Flask-FS requires Python 2.7+ and Flask 0.10+.


.. Amazon S3 support requires Boto.

.. OpenStack Swift support requires python-swift-client.

.. GridFS support requires PyMongo.


Installation
============

You can install Flask-FS with pip:

::

    $ pip install flask-fs

..    # or
..    $ pip install flask-fs[s3]  # For Amazon S3 backend support
..    $ pip install flask-fs[swift]  # For OpenStack swift backend support
..    $ pip install flask-fs[gridfs]  # For GridFS backend support
..    $ pip install flask-fs[all]  # To include all dependencies for all backends

or with easy_install:

::

    $ easy_install flask-fs

..    # or
..    $ easy_install flask-fs[s3]  # For Amazon S3 backend support
..    $ easy_install flask-fs[swift]  # For OpenStack swift backend support
..    $ easy_install flask-fs[gridfs]  # For GridFS backend support
..    $ easy_install flask-fs[all]  # To include all dependencies for all backends


Quick start
===========

TODO: a quick hello world with Flask-Buckets

::

    from flask import Flask
    from flask.ext import fs

    app = Flask(__name__)
    fs.init_app(app)

    images = fs.Storage('images')


    if __name__ == '__main__':
        app.run(debug=True)


Documentation
=============

The full documentation is hosted `on Read the Docs <http://flask-fs.readthedocs.org/en/latest/>`_

Changelog
=========

Current
-------

- Initial release



