Skip to main content

Automate Nominal workflows in Python

Project description

⬖ Nominal

Python client for Nominal test data, storage, & compute

🚧 WIP - API and syntax subject to change

Install

pip3 install nominal --upgrade

Usage

Setup

Retrieve your API key from /sandbox on your Nominal tenant

import nominal as nm
nm.cloud.set_token(...)

API base URL is set to prod by default

import nominal as nm
nm.cloud.set_base_url('PROD') # Set to 'STAGING' for development
nm.cloud.get_base_url()
# 'https://api.gov.nominal.io/api'

Upload a Dataset (4 lines)

import nominal as nm
from nominal import Ingest, Dataset
dataset = Dataset(nm.data.penguins())
# dataset = Ingest().read('../path/to/your/data.csv')
dataset.upload()

Upload a Run (4 lines)

import nominal as nm
from nominal import Run, Dataset
r = Run(datasets=[Dataset(nm.data.penguins())])
# r = Run(path='../path/to/your/data.csv')
r.upload()

Update metadata of an existing Run (4 lines)

from nominal import Run
r = Run(rid = 'ri.scout.gov-staging.run.ce205f7e-9ef1-4a8b-92ae-11edc77441c6')
r.title = 'my_new_run_title'
r.update()

Compare changes made to a Run locally

r.title = 'my_new__new_run_title'
r.diff()

Apply a Check to a Run

TODO

Development

Install the following VSCode extensions:

  • Ruff
  • isort

And add the following lines to User Settings (JSON):

    "[python]": {
        "editor.formatOnSave": true,
        "editor.defaultFormatter": "charliermarsh.ruff",
        "editor.codeActionsOnSave": {
            "source.organizeImports": "explicit",
        },
    },

To make sure your code is linted properly on save.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nominal-0.0.38.tar.gz (246.9 kB view hashes)

Uploaded Source

Built Distribution

nominal-0.0.38-py3-none-any.whl (269.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page