Skip to main content

A python library to upload files on cloud. Supported services - AWS S3, DigitalOcean Spaces, LocalStorage.

Project description

Storedoc 0.1.2

A python module to upload files on cloud. Supported services - AWS S3, DigitalOcean Spaces, LocalStorage.

Installation

To install, simply use pip or easy_install:

$ pip install --upgrade storedoc

or

$ easy_install --upgrade storedoc

Get Started

Upload to AWS S3 Buckets

Initialize the service

from storedoc import Service
client = Service('aws')

Get information of the service

client.describe()

Instantiate AWS S3 Client

    client.connect(
    region_name='//s3.your-region.amazonaws.com',
    endpoint_url='https://s3.amazonaws.com',
    aws_access_key_id='your-access-key',
    aws_secret_access_key='your-secret'
)

Upload the file to S3 bucket (Note: File type supported <werkzeug.datastructures.FileStorage>)

client.upload_file(file, bucket='your-bucket-name')

Upload to DigitalOcean Spaces Buckets

Initialize the service

from storedoc import Service
client = Service('do')

Get information of the service

client.describe()

Instantiate DO Spaces Client

client.connect(
    region_name='//s3.your-region.amazonaws.com',
    endpoint_url='https://your-region.digitaloceanspaces.com',
    aws_access_key_id='your-access-key',
    aws_secret_access_key='your-secret'
)

Upload the file to S3 bucket (Note: File type supported <werkzeug.datastructures.FileStorage>)

client.upload_file(file, bucket='your-bucket-name')

Save File to Local Storage

Initialize the service

from storedoc import Service
client = LocalStorage()

Save file to working directory (Note: File type supported <werkzeug.datastructures.FileStorage>)

client.save_file(file)

Save file to specific directory (Note: File type supported <werkzeug.datastructures.FileStorage>)

client.save_file(file, folder='some-directory-name')

Third Party Libraries and Dependencies

The following libraries will be installed when you install the client library:

  • boto3 (Amazon Web Services SDK for Python)

To-Dos

  • Test cases.

Contribute

  1. Look for an open issue or create new issue to get a dialog going about the new feature or bug that you've discovered.
  2. Fork the repository on Github to start making your changes to the master branch (or branch off of it).
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Make a pull request.

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

storedoc-0.1.2.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

storedoc-0.1.2-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file storedoc-0.1.2.tar.gz.

File metadata

  • Download URL: storedoc-0.1.2.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.15.0 CPython/3.5.2

File hashes

Hashes for storedoc-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4291cd1cd56e15e84170f997e5e5a05cfe1854c5b199ef568af5c4c88e58a30e
MD5 6998cc123093adfba293f6c259047c3e
BLAKE2b-256 8c876df35b564df2ccbddf092617866a2680526a1595497d48d44f0a91eabbe2

See more details on using hashes here.

File details

Details for the file storedoc-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: storedoc-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.15.0 CPython/3.5.2

File hashes

Hashes for storedoc-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fa52f33f5ddd89e454fe96fea9c37c141a27395ca0ccd21de473dc20fb5cac8e
MD5 6e8b38357eb874a41b5c689fdd27cbbb
BLAKE2b-256 b45a3d8e3a212311c7e5ebc62393ba39697c432372ff015a6755be5d8cd7981b

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