evanbldy / flask-fs2

Simple and easy file storages for Flask

Flask-FS2

Simple and easy file storages for Flask.

Compatibility

Flask-FS requires Python 3.7+ and Flask/Werkzeug 2.0.0+.

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)

Contributions

All contributions are welcome as long as they respect the C4 contract.

Code must follow the pep8 convention.

About authors

Flask-FS2 is maintained by CGWire, a company based in France. We help animation and VFX studios to collaborate better through efficient tooling. We already work with more than 70 studios around the world.

It's a fork of this project.

Visit cg-wire.com for more information.