GitLocker: The Coding Marketplace

Description:

dataattributerecommendationsdk 0.14.0

Data Attribute Recommendation Python SDK
A client SDK for the Data Attribute Recommendation service on SAP Business Technology Platform (SAP BTP).
Part of SAP AI Business Services.
Description

Goals of this SDK:

Enable easy consumption of the Data Attribute Recommendation service
Provide convenient higher-level abstraction on top of the service APIs
Serve as reference implementation for other programming languages
Provide sample notebooks for reference usage of various templates provided by DAR

Release Notes
See CHANGELOG.md.
Note that this project follows Semantic Versioning. Versions
below 1.0.0 are not guaranteed to have a stable API. For this reason, please
pay attention to the CHANGELOG.md.
Resources

NEW: TechED 2020 workshop materials, including a Jupyter notebook!
Tutorials on Data Attribute Recommendation - Free Trial Available
Tutorials on this SDK
Data Attribute Recommendation documentation
Blog Articles on Data Attribute Recommendation
Documentation for this SDK

Requirements
To use the SDK, you will need a recent version of Python. We actively support
and test Python 3.5 3.6 up to Python 3.9. We aim to support all officially supported
Python version. This includes any Python version not
listed as end-of-life in the
Python Developer's Guide. You can check
the Travis builds to see which environments are actively tested.
NOTE: Python 3.5 is end-of-life since September 2021.
The SDK will remove support for Python 3.5 at some point after the 0.8.0 release.
Additionally, the pip and virtualenv tools should be installed. See
the installation instructions.
To use the SDK, you will need to have a service instance of the
Data Attribute Recommendation service. For existing users of
SAP BTP, please see the Initial Setup.
If you are new to SAP BTP and Data Attribute Recommendation,
consider one of the following options:

Free Trial via Tutorials on Data Attribute Recommendation
SAP Store
Contact your Sales Representative

Download and Installation
The SDK is installable from the Python Package Index (PyPI). The easiest way
to install the SDK is via pip and virtual environments. With a virtual environment
(virtualenv), the installation process is isolated to a single directory and will
not influence any other projects you may have.
If you are familiar with Python and associated tooling, simply execute:
$ python3 -m virtualenv dar-sdk-venv
$ source dar-sdk-venv/bin/activate/
(dar-sdk-venv) $ pip install data-attribute-recommendation-sdk

In case you prefer more detailed instructions, please see step-by-step
instructions below. A separate, more detailed tutorial
is also available at developers.sap.com.
Step by Step
The following instructions assume a Linux or macOS environment. For Windows, the
process is similar, but the commands may differ slightly. If in doubt, refer
to the Python documentation.
First, create a working directory in your home directory.
$ cd $HOME
$ mkdir data-attribute-recommendation-python-sdk/
$ cd data-attribute-recommendation-python-sdk/

Now, create a virtualenv named dar-sdk-venv.
$ python3 -m virtualenv dar-sdk-venv

If you receive a message command not found: python3, then try using the python
command instead. If you still receive a message about command not found, please
ensure that python is installed.
If you observe No module named virtualenv error messages, make sure that virtualenv
is installed.
Now, activate the newly created environment:
$ source dar-sdk-venv/bin/activate
(dar-sdk-venv) $

The name of the virtualenv is now part of your shell prompt.
Finally, install the SDK and its dependencies:
(dar-sdk-venv) $ pip install data-attribute-recommendation-sdk

If you receive an error message command not found: pip, then refer to
installing pip.
Congratulations! You have sucessfully installed the SDK. You may now import the
SDK package as a first test:
(dar-sdk-venv) $ python3
>>> from sap.aibus.dar.client.data_manager_constants import DataManagerPaths
>>> DataManagerPaths.ENDPOINT_DATASET_COLLECTION
'/data-manager/api/v3/datasets'

To use the SDK, please refer to the SDK documentation. In particular, consider
the SDK security guide.
How to obtain support
For issues with the SDK itself, such as installation problems, please file
an issue in Github.
For questions on how to best use the SDK, consider asking a question in the
SAP Community at answers.sap.com with the Data Attribute Recommendation tag.
When creating your question, add Data Attribute Recommendation as a primary tag.
For issues experienced using the service, please refer to Getting Support in
the main documentation on the SAP Help Portal.
License
Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved.
This file and all other files in this repository are licensed under the
Apache License, v 2.0 except as noted otherwise in the LICENSE file.