Syndeia Cloud 3.4 5 has an official Python2/3 client to Intercax’s Syndeia Cloud v3.4 5 REST API.

Syndeia Cloud REST API - Python SDK

Official Python2/3 client to Intercax’s Syndeia Cloud v3.4 5 SP1 REST API.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 3.45 SP1

• Package version: 3.45.0.21

• Build package: org.openapitools.codegen.languages.PythonClientCodegen

...

• (Ana)conda Package Manager

• Python 2.7 and 3.45+ (natively or via Conda)

• Connection details of Intercax Syndeia Cloud v3.4 5 SP1 server

• Credentials to access Intercax Syndeia Cloud v3.4 5 SP1 server

Installation & Uninstallation

...

conda install syndeia_cloud_34x35x_client_sdk

To install into a specific environment:

conda install -name myenv syndeia_cloud_34x35x_client_sdk

To install from a local file (ie: if you downloaded the package directly):

conda install /some/path/syndeia_cloud_33x35x_client_sdk-3.45.0.21-py_0.tar.bz2  # ex: for v3.45.0.21, update as appropriate

conda uninstall

...

conda uninstall syndeia_cloud_34x35x_client_sdk
conda clean -t # to ensure any old cached tarballs are cleared out

...

The general pattern is to:

1. Instantiate the configuration (once) with the Syndeia Cloud URL, your username, and password (see STEPs 2-3 in Quickstart below)

2. Instantiate the API client using the configuration from previous step (see STEP 4 in Quickstart below)

3. Use the API client object to instantiate other main API classes, such as:

   • AuthAPI for sign-in and other authentication calls (see STEP 5 in Quickstart below).

   • UserAPI for create, read, update, delete operations on users

   • RepositoryAPI for create, read, update, delete operations on repositories (see STEP 6 in Quickstart below)

   • ContainerAPI for create, read, update, delete operations on containers (see STEP 7 in Quickstart below)

   • ArtifactAPI for create, read, update, delete operations on artifacts (see STEP 8 in Quickstart below)

   • RelationAPI for create, read, update, delete operations on relations (see STEP 9 in Quickstart below)

(Strictly speaking, steps 6+ are optional but it will show you how to make sample calls to some of the core endpoint concepts, ie: Repositories, Containers, Artifacts, and Relations)

...

To use the Syndeia Cloud python3 client SDK in Jupyter Notebook:

1. Ensure that you have already installed the SDK (see conda install section above) & JupyterLab/Notebook (conda install jupyterlab or conda install notebook).

2. Launch JupyterLab/Notebook (ex: via Anaconda-Navigator or the CLI) and open the provided example iPython Notebook file (syndeia_cloud_3.

...

1. 5.0_client_sdk_example.ipynb) from the accompanying syndeia_cloud_

...

1. 35x_client_sdk...-py_0_docs package:

   Image Modified

2. Edit the 3rd cell to specify your deployment’s Syndeia Cloud’s configuration.host and configuration.username values as described in the comments.

3. Click in the side area of the editing area and select all cells via Command-A (on Mac) or CTRL-A (on Windows)

4. Run the selected cells by hitting Shift-Enter.

5. You will be prompted for your specified user’s password, enter it in.

   Image Modified

6. After submitting it, you should get results similar to the below for some of the cells ( the exact results will differ depending on what data you have, if any, on the server)

   Image Modified

   If one of the outputs is too verbose, you can encapsulate results in a scrollable area by R-clicking the side area next to a cell and selecting Enable Scrolling for Outputs to make navigating the Jupyter notebook easier.

   Image Modified

Authorization

• Syndeia Cloud 3.4 5 currently supports Basic Auth + an LDAP(S) + SAML2 authentication provider

• Syndeia Cloud 3.4 5 repositories currently support Basic + OAuth

...

Quickstart

Unzip the syndeia_cloud_34x35x_client_sdk-3.45.0.21-py_0_docs.zip , you should see the following file listing:

-rw-r--r--    1 jdoe  staff    34K MaySep 1720 0820:1535 LICENSE
-rw-r--r--@   1 jdoe  staff   133K MaySep 1720 0820:1635 README.html
-rw-r--r--    1 jdoe  staff   126K MaySep 1720 0820:1535 README.md
drwxr-xr-x  293 jdoe  staff   9.2K MaySep 1720 0820:1635 docs
-rw-r--r--    1 jdoe  staff    16K MaySep 1720 0820:1535 html.css
-rw-r--r--    1 jdoe  staff    27K MaySep 1720 0820:1535 syndeia_cloud_3.45.0_client_sdk_example.ipynb

...