uplink-python 1.0.2

Python-native language binding for storj-uplink-c to communicate with the Storj network.

uplink-python binding

Developed using v1.0.2 storj/uplink-c

Initial Set-up (Important)

NOTE: for Golang

Make sure your PATH includes the $GOPATH/bin directory, so that your commands can be easily used Refer: Install the Go Tools:

export PATH=$PATH:$GOPATH/bin

Depending on your operating system, you will need to install:

On Unix

• A proper C/C++ compiler toolchain, like GCC

On macOS

• Xcode : You also need to install the XCode Command Line Tools by running xcode-select --install. Alternatively, if you already have the full Xcode installed, you can find them under the menu Xcode -> Open Developer Tool -> More Developer Tools.... This step will install clang, clang++, and make.

On Windows

• Install Visual C++ Build Environment: Visual Studio Build Tools (using "Visual C++ build tools" workload) or Visual Studio 2017 Community (using the "Desktop development with C++" workload)
• Make sure you have access to site-packages folder inside the directory where python is installed. To do this navigate to the directory where python is installed, if you get an error "Permission Denied", follow the instruction in message box and allow access using security tab.

Binding Set-up

Please ensure you have Python 3.x and pip installed on your system. If you have Python version 3.4 or later, pip is included by default. uplink-python does not support Python 2.x.

$ python get-pip.py

Option 1

Install uplink-python python package with --no-cache-dir tag if re-installing or upgrading from previous version, otherwise tag can be ignored (using Terminal/Powershell/CMD as Administrator):

$ pip install --no-cache-dir uplink-python

Option 2

Follow these steps to set-up binding manually or if libuplinkc.so fails to build using Option 1.

Install uplink-python python package (using Terminal/Powershell/CMD) if not already done in Option 1

$ pip install uplink-python

Install storj-uplink-c go package, by running:

$ go get storj.io/uplink-c

• After git cloning go package, using cmd/terminal, navigate to the $HOME/go/src/storj.io/uplink-c folder.

• Create '.so' file at $HOME/go/src/storj.io/uplink-c folder, by using following command:

$ go build -o libuplinkc.so -buildmode=c-shared

• Copy created libuplinkc.so file into the folder, where Python package was installed (python3.X -> site-packages -> uplink_python)

Project Set-up

To include uplink in you project, import the library, by using following command:

from uplink_python.uplink import *

Create an object of LibUplinkPy class to access all the functions of library. Please refer the sample hello_storj.py file, for example.

variable_name = LibUplinkPy()

Sample Hello Storj!

File hello_storj.py can be found in folder where Python package was installed.

The sample hello_storj.py code calls the uplink.py file and imports the LibUplinkPy binding class to do the following:

• list all buckets in a Storj project
• create a new bucket (if it does not exist) within desired Storj project
• write a file from local computer to the a Storj bucket
• read back the object from the Storj bucket to local system for verification
• list all objects in a bucket
• delete bucket from a Storj project
• create shareable Access with permissions and shared prefix.
• list all buckets and objects with permission to shareable access.

Uplink-Python Binding Functions

NOTE: Every function consists of error response. Please use it, to check if the function call was successful or not. In case, if it is not None, then you may also show the error's text. Please refer the sample hello_storj.py file, for example.

request_access_with_passphrase(String, String, String)

* function requests satellite for a new access grant using a passphrase
* pre-requisites: none
* inputs: Satellite Address (String), API key (String) and Passphrase (String)
* output: AccessResult (Object), Error (String) if any else None

config_request_access_with_passphrase(Object, String, String, String)

* function requests satellite for a new access grant using a passphrase and custom configuration
* pre-requisites: none
* inputs: Config (Object), Satellite Address (String), API key (String) and Passphrase (String)
* output: AccessResult (Object), Error (String) if any else None

• Note: To set Config Refer: Config

open_project(Object)

* function opens Storj(V3) project using access grant.
* pre-requisites: request_access_with_passphrase or parse_access function has been already called
* inputs: Access (Object)
* output: ProjectResult (Object), Error (String) if any else None

config_open_project(Object, Object)

* function opens Storj(V3) project using access grant and custom configuration.
* pre-requisites: request_access_with_passphrase or parse_access function has been already called
* inputs: Config (Object), Access (Object)
* output: ProjectResult (Object), Error (String) if any else None

• Note: To set Config Refer: Config

close_project(Object)

* function closes the Storj(V3) project.
* pre-requisites: open_project function has been already called
* inputs: Project (Object)
* output: Error (Object) if any else None

ensure_bucket(Object, String)

* function creates a new bucket and ignores the error when it already exists
* pre-requisites: open_project function has been already called
* inputs: Project (Object) ,Bucket Name (String)
* output: BucketResult (Object), Error (String) if any else None

stat_bucket(Object, String)

* function returns information about a bucket.
* pre-requisites: open_project function has been already called
* inputs: Project (Object), Bucket Name (String)
* output: BucketResult (Object), Error (String) if any else None

create_bucket(Object, String)

* function creates a new bucket.
* pre-requisites: open_project function has been already called
* inputs: Project (Object), Bucket Name (String)
* output: BucketResult (Object), Error (String) if any else None

list_buckets(Object, Object)

* function lists buckets
* pre-requisites: open_project function has been already called
* inputs: Project (Object), ListBucketsOptions (Object)
* output: Bucket List (Python List), Error (String) if any else None

• Note: To set List Bucket Options Refer: ListBucketOptions

delete_bucket(Object, String)

* function deletes a bucket.
* pre-requisites: open_project function has been already called
* inputs: Project (Object), Bucket Name (String)
* output: BucketResult (Object), Error (String) if any else None

stat_object(Object, String, String)

* function returns information about an object at the specific key.
* pre-requisites: open_project
* inputs: Project (Object) ,Bucket Name (String) , Object Key(String)
* output: ObjectResult (Object), Error (string) if any else None

list_objects(Object, String, Object)

* function lists objects
* pre-requisites: open_project function has been already called
* inputs: Project (Object), Bucket Name (String), ListObjectsOptions (Object)
* output: Bucket List (Python List), Error (String) if any else None

• Note: To set List Object Options Refer: ListObjectOptions

delete_object(Object, String, String)

* function deletes an object.
* pre-requisites: open_project function has been already called
* inputs: Project (Object), Bucket Name (String), Object Key (String)
* output: ObjectResult (Object), Error (String) if any else None

upload_object(bject, String, String, Object)

* function starts an upload to the specified key.
* pre-requisites: open_project function has been already called
* inputs: Project (Object), Bucket Name (String), Object Key (String), Upload Options (Object)
* output: UploadResult (Object), Error (String) if any else None

• Note: To set Upload Options Refer: UploadOptions

upload_write(Object, LP_c_ubyte, Integer)

* function uploads bytes data passed as parameter to the object's data stream.
* pre-requisites: upload_object function has been already called
* inputs: Upload (Object), Bytes Data Stream(LP_c_ubyte) , Length (Integer)
* output: WriteResult (Object), Error (String) if any else None

• Note: The Data to upload (LP_c_ubyte) passed to function should be a ctypes char or uint8 pointer only. (Please refer the sample hello_storj.py file, for example.)

upload_commit(Object)

* function commits the uploaded data.
* pre-requisites: upload_object function has been already called
* inputs: Upload (Object)
* output: Error (Object) if any else None

upload_abort(Object)

* function aborts an ongoing upload.
* pre-requisites: upload_object function has been already called
* inputs: Upload (Object)
* output: Error (Object) if any else None

upload_set_custom_metadata(Object, Object)

* function to set custom meta information while uploading data
* pre-requisites: upload_object function has been already called
* inputs: Upload (Object), CustomMetadata (Object)
* output: Error (Object) if any else None

• Note: To set Custom Metadata Refer: CustomMetadata

upload_info(Object)

* function returns the last information about the uploaded object.
* pre-requisites: upload_object function has been already called
* inputs: Upload (Object)
* output: Object Result (Object), Error (String) if any else None

download_object(Object, String, String, Object)

* function starts download to the specified key.
* pre-requisites: open_project function has been already called
* inputs: Project (Object), Bucket Name(String), Object Key(String), Download Options(Object)
* output: DownloadResult (Object), Error (String) if any else None

• Note: To set Download Options Refer: DownloadOptions

download_read(Object, Integer)

* function downloads from object's data stream into bytes up to length amount.
* pre-requisites: download_object function has been already called
* inputs: Download (Object), Length(Integer)
* output: Data downloaded (LP_c_ubyte), ReadResult (Object), Error (String) if any else None

close_download(Object)

* function closes the download.
* pre-requisites: download_object function has been already called
* inputs: Download (Object)
* output: Error (Object) if any else None

download_info(Object)

* function returns information about the downloaded object.
* pre-requisites: download_object function has been already called
* inputs: Download (Object)
* output: Object Result (Object), Error (String) if any else None

parse_access(String)

* function to parses serialized access grant string
* pre-requisites: none
* inputs: Serialized Access (String)
* output: AccessResult (Object), Error (String) if any else None

access_serialize(Object)

* function serializes access grant into a string.
* pre-requisites: request_access_with_passphrase or parse_access function has been already called
* inputs: Access (Object)
* output: StringResult (Object), Error (String) if any else None

access_share(Object, Object, List)

* function creates new access grant with specific permission. Permission will be applied to prefixes when defined.
* pre-requisites: request_access_with_passphrase or parse_access function has been already called
* inputs: Access (Object), Permission (Object), Share Prefix (Python List of Dictionaries)
* output: String Result (Object), Error (String) if any else None

• Note: To set Permission Refer: Permission
• Note: To set Shared Prefix Refer: SharedPrefix