sequoia-client-sdk 1.2.0

Sequoia Python Client SDK

Python Sequoia Client SDK

A Python Client SDK for interacting with client services.

The central idea is that Client SDK allows python application code to communicate with the Piksel Palette RESTful RESTful services. Users can also search, filter and select their response collections.

Installation

pip install sequoia-client-sdk

Usage

Creating a SequoiaClient

The Sequoia RESTful services have an OAuth token-based authorisation model, meaning that the Client SDK must first acquire a time-limited access token before making further requests.

To create the client it is needed to provide credentials and the url for the service registry:

client = Client("https://registry-sandbox.sequoia.piksel.com/services/testmock",
                grant_client_id="clientId",
                grant_client_secret="clientSecret")

Creating an endpoint

An endpoint defines the resource on which to perform the operations.

profile_endpoint = client.workflow.profiles
content_endpoint = client.metadata.contents

API methods

Read

Retrieves one resource given its reference and owner and returns the response retrieved.

endpoint.read(owner, ref)

Browse

Retrieves the list of resources that matches with the criteria and returns the response.

endpoint.browse(owner, criteria)

Store

Creates one or more resources and returns the response retrieved.

endpoint.store(owner, json)

Criteria API for Requesting Data

The SDK supports a fluent criteria API to abstract client code from the details of the Sequoia query syntax:

endpoint.browse("testmock", Criteria().add(
    StringExpressionFactory.field("contentRef").equal_to("testmock:sampleContent")))

The following filtering criteria are supported:

equalTo

StringExpressionFactory.field("engine").equal_to("diesel")

Will generate the criteria expression equivalent to: field=diesel (withEngine=diesel)

Inclusion of related documents

The SDK support inclusion of related documents up to 1 level (direct relationships).

Both, direct and indirect relationships, are allowed. In each case resource’s reference are needed to perform the mapping.

Criteria().add(inclusion=Inclusion.resource('assets'))

Selecting fields

The SDK allows to specify which fields will be present in the response, discarding the rest of them.

For now it can be used only for Inclusions

Criteria().add(inclusion=Inclusion.resource('assets').fields('name','ref'))

Paginating results

Iterator

Browse responses can be paginated. To paginate results, browse response has to be used as an iterator.

for response in endpoint.browse('testmock'):
    resources = response.resources

Not iterator

If browse function is not used as an iterator, only first page is retrieved. i.e:

response = endpoint.browse('testmock')
resources_in_page_1 = response.resources

Paginating linked resources

Inclusion

When doing an inclusion, service returns a list of linked resources. Those resources can be paginated. Let’s assume a browse of contents is performed with assets resource as an inclusion. To perform pagination:

for linked_assets in endpoint.browse('testmock').linked('assets'):
    for linked_asset in linked_assets:
        asset_name = linked_asset['name']

If linked response is not used as an iterator, only first page of linked resources is retrieved:

linked_assets =  endpoint.browse('testmock').linked('assets')
for linked_asset in linked_assets.resources:
    asset_name = linked_asset['name']

Development

It has been tested for Python 2.7, 3.5 and 3.6

You can use the included command line tool make to work with this project

Preparing environment

Create new virtualenv

It’s encouraging to create a new virtual environment and install all the dependencies in it. You can use these commands:

mkdir -p ~/.virtualenvs
virtualenv -p python3.6 ~/.virtualenvs/sequoia-python-client-sdk
workon sequoia-python-client-sdk
pip install -r requirements.txt
pip install -r requirements_test.txt

Testing

There are two different ways of running the tests.

Run tests on the current environment

Using pytest option will run all the unit tests over your environment.

make test

Run tests on every compatible python version

While using the option test will set up a virtual environment for the supported version of Python, i.e. 2.7, 3.5 and 3.6 and will run all the tests on each of them.

make test-all

Lint

To make sure the code fulfills the format run

make lint

History

1.0.0

• First release.

1.1.0 (2017-10-25)

• Upgrade to Python 3.6

1.2.0 (2019-03-06)

• Libraries urllib3 and requests upgraded to solve security issues:

  • CVE-2018-20060

  • CVE-2018-18074