https://github.com/noirbizarre/flask-fs

Simple and easy file storages for Flask
https://github.com/noirbizarre/flask-fs

flask gridfs mongodb s3 storage swift

Last synced: 2 months ago
JSON representation

Simple and easy file storages for Flask

• Host: GitHub
• URL: https://github.com/noirbizarre/flask-fs
• Owner: noirbizarre
• License: mit
• Created: 2014-10-06T01:12:01.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-07-07T14:05:16.000Z (over 2 years ago)
• Last Synced: 2024-10-03T19:40:24.061Z (3 months ago)
• Topics: flask, gridfs, mongodb, s3, storage, swift
• Language: Python
• Homepage: https://flask-fs.readthedocs.org
• Size: 414 KB
• Stars: 31
• Watchers: 4
• Forks: 15
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
========

Flask-FS

========

.. image:: https://travis-ci.org/noirbizarre/flask-fs.svg?branch=master

    :target: https://travis-ci.org/noirbizarre/flask-fs

    :alt: Build status

.. image:: https://coveralls.io/repos/noirbizarre/flask-fs/badge.svg?branch=master

    :target: https://coveralls.io/r/noirbizarre/flask-fs?branch=master

    :alt: Code coverage

.. image:: https://readthedocs.org/projects/flask-fs/badge/?version=latest

    :target: http://flask-fs.readthedocs.org/en/latest/

    :alt: 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:

.. code-block:: console

    $ 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

===========

.. code-block:: python

    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 `_