Metadata-Version: 2.1
Name: nominal
Version: 0.0.23
Summary: Automate Nominal workflows in Python
Author: JP
Author-email: jack@nominal.io
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: jsondiff (>=2.2.0,<3.0.0)
Requires-Dist: keyring (>=25.0.0,<26.0.0)
Requires-Dist: polars (>=1.4.1,<2.0.0)
Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: rich (>=13.7.1,<14.0.0)
Description-Content-Type: text/markdown

# ⬖ Nominal
Python client for Nominal test data, storage, &amp; compute

🚧 WIP - API and syntax subject to change

## Install

> pip3 install nominal

## Usage

### Set your API key

Retrieve your API key from /sandbox on your Nominal tenant

```py
import nominal as nm

nm.set_token(...)
```

### Upload a Dataset (3 lines)

```py
from nominal import Ingest

dataset = Ingest().read_csv('../data/penguins.csv')

dataset.upload()
```

### Upload a Run (3 lines)

```py
from nominal import Run

r = Run(path='../data/penguins.csv')

r.upload()
```

### Update metadata of an existing Run (4 lines)

```py
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 madde to a Run locally

```py
from nominal import Run

r = Run(rid = 'ri.scout.gov-staging.run.ce205f7e-9ef1-4a8b-92ae-11edc77441c6')

r.title = 'my_new_run_title'

r.diff()
```

### Apply a Check to a Run

TODO

