Skip to content

noirbizarre/flask-fs

Repository files navigation

Flask-FS

Build status Code coverage Documentation status

Simple and easy file storages for Flask

Compatibility

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

Amazon S3 support requires Boto3.

GridFS support requires PyMongo 3+.

OpenStack Swift support requires python-swift-client.

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

Quick start

from flask import Flask
import flask_fs as 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