Package: data-attribute-recommendation-sdk
Data Attribute Recommendation Python SDKA client SDK for the Data Attribute Recommendation service on SAP Business Technology Platform (SAP BTP).
Part ofSAP AI Business Services.DescriptionGoals of this SDK:Enable easy consumption of the Data Attribute Recommendation serviceProvide convenient higher-level abstraction on top of the service APIsServe as reference implementation for other programming languagesProvide sample notebooks for reference usage of various templates provided by DARRelease NotesSeeCHANGELOG.md.Note that this project followsSemantic Versioning. Versions
below1.0.0are not guaranteed to have a stable API. For this reason, please
pay attention to theCHANGELOG.md.ResourcesNEW:TechED 2020 workshop materials, including a Jupyter notebook!Tutorials on Data Attribute Recommendation-Free Trial AvailableTutorials on this SDKData Attribute Recommendation documentationBlog Articles on Data Attribute RecommendationDocumentation for this SDKRequirementsTo use the SDK, you will need a recent version of Python. We actively support
and test Python3.53.6 up to Python 3.9. We aim to support all officially supported
Python version. This includes any Python version not
listed asend-of-lifein thePython Developer's Guide. You can check
theTravis buildsto see which environments are actively tested.NOTE:Python 3.5 isend-of-life since September 2021.
The SDK willremove supportfor Python 3.5 at some point after the 0.8.0 release.Additionally, thepipandvirtualenvtools should be installed. See
theinstallation 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 theInitial Setup.If you are new to SAP BTP and Data Attribute Recommendation,
consider one of the following options:Free Trial viaTutorials on Data Attribute RecommendationSAP StoreContact your Sales RepresentativeDownload and InstallationThe SDK is installable from the Python Package Index (PyPI). The easiest way
to install the SDK is viapip 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-mvirtualenvdar-sdk-venv
$sourcedar-sdk-venv/bin/activate/(dar-sdk-venv)$pipinstalldata-attribute-recommendation-sdkIn case you prefer more detailed instructions, please seestep-by-stepinstructions below. A separate, more detailed tutorialis also available at developers.sap.com.Step by StepThe 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 thePython 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 nameddar-sdk-venv.$ python3 -m virtualenv dar-sdk-venvIf you receive a messagecommand not found: python3, then try using thepythoncommand instead. If you still receive a message aboutcommand not found, please
ensure thatpython is installed.If you observeNo module named virtualenverror messages, make sure thatvirtualenvis installed.Now, activate the newly created environment:$sourcedar-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)$pipinstalldata-attribute-recommendation-sdkIf you receive an error messagecommand not found: pip, then refer toinstalling 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 theSDK documentation. In particular, consider
theSDK security guide.How to obtain supportFor issues with the SDK itself, such as installation problems, please file
anissue in Github.For questions on how to best use the SDK, consider asking a question in the
SAP Community atanswers.sap.comwith theData Attribute Recommendationtag.
When creating your question, addData Attribute Recommendationas a primary tag.For issues experienced using the service, please refer toGetting Supportin
the main documentation on the SAP Help Portal.LicenseCopyright (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 theLICENSEfile.