Skip to main content

A clean abstraction over cloud file storage platforms like S3, Alicloud, or Heroku.

Project description

Simple cloud file storage for Flask applications on platforms like S3, Alicloud, or Heroku.

import os

from flask import Flask
from flask_warehouse import Warehouse

# 1. Configuring Warehouse
app = Flask(__name__)
app.config['WAREHOUSE_DEFAULT_SERVICE'] = 's3'          # or 'file' for filesystem
app.config['WAREHOUSE_DEFAULT_LOCATION'] = 'us-west-1'  # required for 's3'
app.config['WAREHOUSE_DEFAULT_BUCKET'] = None


app.config['AWS_ACCESS_KEY_ID'] = '...'                 # required for 's3'
app.config['AWS_SECRET_ACCESS_KEY'] = '...'             # required for 's3'

warehouse = Warehouse(app)

# Object-oriented approach:
bucket = warehouse.bucket('mybucket')
oo_cubby = bucket.cubby('keys')

# Or compact approach:
compact_cubby = warehouse('s3:///mybucket/keys')

assert oo_cubby == compact_cubby

cubby = oo_cubby

# 2. Writing to/from bytes
contents = b'12345'
cubby.store(bytes=contents)

assert cubby.filesize() == 5

cubby_contents = cubby.retrieve()
assert cubby_contents == contents

# 3. Writing to/from files
filepath = "local.txt"
with open(filepath, 'wb') as f:
    f.write(b"Here are the contents of a file.")

cubby.store(filepath=filepath)
assert os.path.getsize(filepath) == cubby.filesize()

assert cubby.retrieve() == open(filepath, 'rb').read()
```

History

0.1.0 (2019-03-26)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for flask_warehouse, version 0.1.12
Filename, size File type Python version Upload date Hashes
Filename, size flask_warehouse-0.1.12-py2.py3-none-any.whl (9.5 kB) File type Wheel Python version 3.7 Upload date Hashes View
Filename, size flask_warehouse-0.1.12.tar.gz (17.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page