datarobot-early-access

About datarobot_early_access

.. image:: https://img.shields.io/pypi/v/datarobot_early_access.svg :target: https://pypi.python.org/pypi/datarobot-early-access/ .. image:: https://img.shields.io/pypi/pyversions/datarobot_early_access.svg .. image:: https://img.shields.io/pypi/status/datarobot_early_access.svg

DataRobot is a client library for working with the DataRobot_ platform API. This package is the "early access" version of the client. Do NOT use this package in production--you will expose yourself to risk of breaking changes and bugs. For the most stable version, see the quarterly release on PyPI at https://pypi.org/project/datarobot/.

This package is released under the terms of the DataRobot Tool and Utility Agreement, which can be found on our Legal_ page, along with our privacy policy and more.

Installation

Python >= 3.7 are supported. You must have a datarobot account.

::

$ pip install datarobot_early_access

Usage

The library will look for a config file ~/.config/datarobot/drconfig.yaml by default. This is an example of what that config file should look like.

::

token: your_token endpoint: https://app.datarobot.com/api/v2

Alternatively a global client can be set in the code.

::

import datarobot as dr dr.Client(token='your_token', endpoint='https://app.datarobot.com/api/v2')

Alternatively environment variables can be used.

::

export DATAROBOT_API_TOKEN='your_token' export DATAROBOT_ENDPOINT='https://app.datarobot.com/api/v2'

See documentation_ for example usage after configuring.

Extra

datarobot_early_access has the following optional groups:

• auth (requires Python 3.9+): Provides an abstraction to handle OAuth2 authentication with DataRobot API (11.1+). This can be used in DataRobot Custom Applications and on its own.
• auth-authlib (requires Python 3.9+): OAuth2 authentication handling via Authlib. This can be used in DataRobot Custom Applications and on its own.

You can install these optional groups by specifying them in the pip command, for example:

::

$ pip install datarobot_early_access[auth]

Helpful links

• API quickstart guide <https://docs.datarobot.com/en/docs/api/api-quickstart/index.html>_
• Code examples <https://docs.datarobot.com/en/docs/api/guide/python/index.html>_
• Common use cases <https://docs.datarobot.com/en/docs/api/guide/common-case/index.html>_

Bug Reporting and Q&A

To report issues or ask questions, send email to the team <[e-mail]>_.

.. _datarobot: https://datarobot.com .. _documentation: https://datarobot-public-api-client.readthedocs-hosted.com/en/early-access/ .. _legal: https://www.datarobot.com/legal/