Metadata-Version: 1.1
Name: storj
Version: 0.1.6
Summary: A Python SDK for the Storj API
Home-page: http://storj.io
Author: Daniel Hawkins,Fabian Barkhau,Mike Bailey,Pedro Salgado,James Prestwich
Author-email: hwkns@alum.mit.edu;f483@storj.io;mibgranny@aol.com;steenzout@ymail.com;james@storj.io
License: MIT
Description: ################
        storj-python-sdk
        ################
        
        |BuildLink|_ |CoverageLink|_ |LicenseLink|_
        
        .. |BuildLink| image:: https://img.shields.io/travis/Storj/storj-python-sdk/master.svg?label=Build-Master
        .. _BuildLink: https://travis-ci.org/Storj/storj-python-sdk
        
        .. |CoverageLink| image:: https://img.shields.io/coveralls/Storj/storj-python-sdk/master.svg?label=Coverage-Master
        .. _CoverageLink: https://coveralls.io/r/Storj/storj-python-sdk
        
        .. |LicenseLink| image:: https://img.shields.io/badge/license-MIT-blue.svg
        .. _LicenseLink: https://raw.githubusercontent.com/Storj/storj-python-sdk
        
        
        A Python SDK for the Storj API.
        
        
        ============
        Installation
        ============
        
        ::
        
            pip install storj
        
        
        =====
        Usage
        =====
        
        ---------------------
        Create a user account
        ---------------------
        
        .. code:: python
        
            import storj
            storj.register_new_user(
                email='someone@email.com',
                password='a better password than this'
            )
            # Check email for confirmation link
        
        ---------------------------------------------------------
        Generate a key pair and start using it for authentication
        ---------------------------------------------------------
        
        .. code:: python
        
            import storj
            (private_key, public_key) = storj.generate_new_key_pair()
            storj.authenticate(
                email='someone@email.com',
                password='a better password than this'
            )
            storj.public_keys.add(public_key)
            storj.authenticate(ecdsa_private_key=private_key)
        
        -----------------------
        Manage your public keys
        -----------------------
        
        .. code:: python
        
            import storj
        
            # Get all registered public keys
            key_list = storj.public_keys.all()
        
            # Add a key
            storj.public_keys.add(public_key)
        
            # Remove one key
            storj.public_keys.remove(public_key)
        
            # Remove all keys
            storj.public_keys.clear()
        
        -------------------
        Manage your buckets
        -------------------
        
        .. code:: python
        
            import storj
        
            # Get all buckets
            bucket_list = storj.buckets.all()
        
            # Get a single bucket
            existing_bucket = storj.buckets.get(id='56ef0d4656bf7b950faace7a')
        
            # Create a new bucket
            new_bucket = storj.buckets.create(name='my first bucket')
            another_bucket = storj.buckets.create(
                name='another bucket', storage_limit=300, transfer_limit=100
            )
        
            # Delete a bucket
            new_bucket.delete()
        
            # Delete a bucket without fetching it
            storj.buckets.delete(bucket_id='56ef0d4656bf7b950faace7a')
        
        ---------------------------------------
        Get file metadata for files in a bucket
        ---------------------------------------
        
        .. code:: python
        
            existing_bucket.files.all()
        
        ----------------------------------------
        Create a PUSH or PULL token for a bucket
        ----------------------------------------
        
        .. code:: python
        
            push_token = existing_bucket.tokens.create(operation='PUSH')
        
        -------------
        Upload a file
        -------------
        
        .. code:: python
        
            # Use a file path string
            new_bucket.files.upload('/path/to/file.txt')
        
            # Or a file handle
            with open('/path/to/another/file.png') as file:
                another_bucket.files.upload(file)
        
        ---------------
        Download a file
        ---------------
        
        .. code:: python
        
            files = existing_bucket.files.all()
            txt_file = files[0]
            txt_file_contents = txt_file.download()
        
        -------------
        Delete a file
        -------------
        
        .. code:: python
        
            existing_file.delete()
        
        -----------------------------
        Manage a bucket's public keys
        -----------------------------
        
        .. code:: python
        
            # Get all registered public keys
            key_list = existing_bucket.authorized_public_keys.all()
        
            # Add a key
            existing_bucket.authorized_public_keys.add(public_key)
        
            # Remove a key
            existing_bucket.authorized_public_keys.remove(public_key)
        
            # Remove all keys
            existing_bucket.authorized_public_keys.clear()
        
        ------------------------------
        Use your own Storj API service
        ------------------------------
        
        .. code:: python
        
            import storj
            storj.api_client.base_url = 'https://myserver.org'
        
Keywords: storj,bridge,metadisk,api,client,sdk,python
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP
