Skip to main content

...

Project description

s3vault

A library for storing documents in AWS s3

Before you start

For best results, create a bucket with the following settings:

  • Encryption on
  • Versioning on

Installation

pip install s3vault

Environment variables

The following environment variables can optionally be provided:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_S3_REGION_NAME

Usage

from s3vault.vault import Vault
vault = Vault(bucket, owner_id, collection)

You can also provide aws_access_key_id, aws_secret_access_key and aws_s3_region_name, otherwise if will default to the values in the environment variables above.

Upload a file from a url

vault.upload_from_url(url, filename, extension='pdf')
  • url: the url to fetch the file to store from
  • filename the Key at which to store the object. Convention: :collection/:owner_id/:object_id

TODO: this method should use the same convention as the below methods to enforce consistency

Get a file

vault.get_object(object_id)
vault.get_versions(object_id)

Project details


Download files

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

Source Distribution

s3vault-0.1.1.tar.gz (2.9 kB view details)

Uploaded Source

File details

Details for the file s3vault-0.1.1.tar.gz.

File metadata

  • Download URL: s3vault-0.1.1.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for s3vault-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0aaeb3bb26404912e4583b4afe65ad1de4edcd618904ce4f80857a0188f95595
MD5 1e18924c926e4ab354ab980f4ffb6af9
BLAKE2b-256 cbc3faea3f4d8615320c299cd8d8df094ce1355209dd37f3a473122745ce5056

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page