Metadata-Version: 2.1
Name: cloudstorageio
Version: 1.1.3
Summary: Cloud storage IO for humans
Home-page: https://github.com/cognaize/cloudstorageio
Author: Vahagn Ghazaryan
Author-email: vahagn.ghazayan@gmail.com
License: UNKNOWN
Description: # cloudstorageio
        
        Storage agnostic IO interface for humans
        
        _Developed and tested on python 3.6+_
        
        [GitHub](https://github.com/VahagnGhaz/cloudstorageio)
        
        [PyPi](https://pypi.org/project/cloudstorageio)
        
        ## Getting Started
        These instructions will get you a copy of the project up and running on your local machine.
        
        * #### S3 configs
            ```bash
            pip install awscli --upgrade --user
            ```
            set your aws configs
            ```bash
             sudo apt install awscli
            ```
        
            ```bash
            $ aws configure
            AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
            AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
            Default region name [None]: us-west-2
            Default output format [None]: json
             ```
           [click here](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html#installation) for more info about configuration and installation
        
        * #### Google cloud storage configs
           Provide authentication credentials to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS.
           Replace [FILE_NAME] with the file of the JSON file that contains your service account key
        
            ```bash
           GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/[FILE_NAME].json"
            ```
        
           [click here](https://cloud.google.com/storage/docs/reference/libraries) for more info about configuration and installation
        
        * #### Dropbox workspace configs
            Provide app access token by setting the environment variable DROPBOX_TOKEN.
            Replace [TOKEN] with the generated token of your dropbox app
        
            ```bash
            DROPBOX_TOKEN='TOKEN'
            ```
        
           [click here](http://99rabbits.com/get-dropbox-access-token/) for more info about configuration and installation
        
        
        ### Installation
        ```
        pip install cloudstorageio
        ```
        
        ### Usage
        
        * Write and read file
        ```python
        from cloudstorageio import CloudInterface
        
        google_file_path = 'gs://bucket-name/path-to-file/sample-file.txt'
        s3_file_path = 's3://bucket-name/path-to-file/sample-pic.jpg'
        ci = CloudInterface()
        
        # Write text to Google cloud storage file
        with ci.open(google_file_path, 'w') as f:
           f.write("Lorem Ipsum is simply dummy text")
        # OR
        ci.save(google_file_path, "Lorem Ipsum is simply dummy text")
        
        # Read picture from S3 storage
        with ci.open(s3_file_path, 'rb') as f:
            s3_output = f.read()  # binary content of picture
        # OR
        ci.fetch(s3_file_path)
        
        ```
        
        * Remove, list, and check folder/file
        ```python
        from cloudstorageio import CloudInterface
        
        dropbox_folder_path = 'dbx://bucket-name/folder'
        s3_file_path = 's3://bucket-name/path-to-file/sample-pic.jpg'
        ci = CloudInterface()
        
        ci.isfile(s3_file_path) # returns True
        ci.isdir(dropbox_folder_path) # returns True
        ci.remove(s3_file_path) # removes file
        ci.listdir(dropbox_folder_path) # lists folder content
        ```
        * Copy file
        ```python
        from cloudstorageio import CloudInterface
        
        dropbox_file_path = 'dbx://bucket-name/path-to-file/sample-pic.jpg'
        gs_file_path = 'gs://bucket-name/path-to-file/sample-file.txt'
        ci = CloudInterface()
        
        ci.copy(from_path=dropbox_file_path, to_path=gs_file_path) # copies dropbox file to gs
        ```
        
        * Copy dir
        ```python
        from cloudstorageio import CloudInterface
        
        s3_dir = 's3://bucket-name/sample_folder'
        gs_dir = 'gs://bucket-name/sample_folder'
        ci = CloudInterface()
        
        ci.copy_dir(source_dir=s3_dir, dest_dir=gs_dir) # copies s3 folder to gs
        ```
        
        _Powered by_ ![](/docs/cognaize_logo.png) [Cognaize](https://www.cognaize.com/) 
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
