Table of Contents | ||||
---|---|---|---|---|
|
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 REST API.
This Python package is automatically generated by the OpenAPI Generator project:
API version: 3.45
Package version: 3.45.0.2
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 server
Credentials to access Intercax Syndeia Cloud v3.4 5 server
Installation & Uninstallation
...
Code Block | ||
---|---|---|
| ||
conda install syndeia_cloud_34x35x_client_sdk |
To install into a specific environment:
Code Block | ||
---|---|---|
| ||
conda install -name myenv syndeia_cloud_34x35x_client_sdk |
To install from a local file (ie: if you downloaded the package directly):
Code Block | ||
---|---|---|
| ||
conda install /some/path/syndeia_cloud_33x35x_client_sdk-3.45.0.2-py_0.tar.bz2 # ex: for v3.45.0.2, update as appropriate |
...
Code Block | ||
---|---|---|
| ||
conda uninstall syndeia_cloud_34x35x_client_sdk conda clean -t # to ensure any old cached tarballs are cleared out |
...
Ensure that you have already installed the SDK (see conda install section above) & JupyterLab/Notebook (
conda install jupyterlab
orconda install notebook
).Launch JupyterLab/Notebook (ex: via Anaconda-Navigator or the CLI) and open the provided example iPython Notebook file (
syndeia_cloud_3.45.0_client_sdk_example.ipynb
) from the accompanyingsyndeia_cloud_34x35x_client_sdk...-py_0_docs
package:Edit the 3rd cell to specify your deployment’s Syndeia Cloud’s
configuration.host
andconfiguration.username
values as described in the comments.Click in the side area of the editing area and select all cells via Command-A (on Mac) or CTRL-A (on Windows)
Run the selected cells by hitting Shift-Enter.
You will be prompted for your specified user’s password, enter it in.
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)
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.
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.2-py_0_docs.zip
, you should see the following file listing:
Code Block | ||
---|---|---|
| ||
-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 |
...