Workbooks in Nominal with Python
Workbooks are Nominal’s tool for creating and sharing interactive data visualizations and analyses. They can be created directly on the Nominal platform or programmatically using the Nominal Python SDK.
Creating a Workbook from a Template
Prerequisites
Make sure you have the nominal Python packages installed. You can install it using:
Connect to Nominal
When using the Nominal client library, there are two primary ways of authenticating:
Storing credentials to disk
First, run the following in your terminal and follow on-screen prompts to insert the base_url and API key:
This will store your API key in a config file ~/.nominal.yml
.
The API key will automatically be used when using the client again.
Directly using credentials in your scripts
NOTE: you should never share your Nominal API key with anyone. We therefore recommend that you not save it in your code and/or scripts.
Steps to Create a Workbook from a Template
- Obtain the Template RID:
- Navigate to the Nominal platform.
- Go to Workbooks ➔ Templates.
- Click on the desired template.
- In the top-left corner next to the template name, click the dropdown arrow ⌄.
- Select Copy RID to copy the template RID to your clipboard.
- Obtain the Run RID:
- Navigate to Runs.
- Click on the run you want to associate with the workbook.
- On the right side of the screen, locate the RID under “Metadata”.
- Create the Workbook Using the SDK:
Accessing Your New Workbook
After creating the workbook programmatically:
- Navigate back to Workbooks on the Nominal platform.
- Locate your new workbook titled “My New Workbook”.
- Open it to view and interact with your data visualizations.