Skip to content

Client library quickstart

This quickstart takes place in a self explaining Jupyter Notebook. The code in the notebook uses the Python/R client library for UbiOps to create a deployment. This quickstart takes place in self explaining Jupyter Notebook. One notebook is for Python and the other one is for R.

Requirements

  1. UbiOps account

  2. After you have made your account you need to install either the UbiOps Python client library or the UbiOps R client library.

  3. If you want to install the Python client library, run pip install ubiops.

  4. If you want to install the R client library, use devtools:

        install.packages("devtools")
    
        library(devtools)
    
        install_github("UbiOps/client-library-r")
    

Create an API token

Before downloading the notebook you need to create an API token. The client library uses this token to securely authenticate with UbiOps.

To create a token go to the Users & permissions page. You can find it in the side bar. On this page you can add a token by clicking the Add token button. Give your new token a name, assign the 'project-editor' role to the token and save the token in a safe place.

User & permissions

On this page you can add a token by clicking the Add token button. Give your new token a name, assign the 'project-editor' role to the token and save the token in safe place.

The Python notebook

Download the Python notebook or if you do not have Jupyter Notebook installed you can take a look at the source on Github

The R notebook

Download the R notebook. If you want more information, visit our Github page which explains the notebook structure in more detail.

Next steps

If you finished this quickstart and like the format you can take a look at our Tutorials page. This is collections of howto's in the same format but with other examples and usecases, including more complex examples.