Metadata-Version: 2.4
Name: bluearf-nova
Version: 0.1.0
Summary: Python SDK and CLI for the Bluearf Nova Public API
Author: Bluearf
License-Expression: MIT
Project-URL: Homepage, https://bluearf.com
Project-URL: Documentation, https://bluearf-nova-api-walbuhs3uq-uc.a.run.app/v1
Project-URL: Repository, https://github.com/bluearf/bluearf-nova-sdk
Keywords: bluearf,nova,carbon,esg,sustainability,api,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# bluearf-nova

Python SDK and CLI for the Bluearf Nova Public API.

## Install

```bash
pip install bluearf-nova
```

## SDK

```python
from bluearf_nova import BluearfNova

client = BluearfNova(api_key="BLUEARF_API_TOKEN")

print(client.credits.get())
vehicles = client.vehicles.list(company_id="COMPANY_ID", limit=25)
result = client.calculations.passenger_commercial_vehicles(
    company_id="COMPANY_ID",
    coid="VEHICLE_OR_FACILITY_ID",
    year=2024,
)
```

## CLI

```bash
export BLUEARF_NOVA_API_TOKEN="BLUEARF_API_TOKEN"

bluearf credits get
bluearf usage list
bluearf vehicles list --company-id COMPANY_ID
bluearf vehicle-models search --brand Toyota --model Corolla
bluearf carbon-records list --company-id COMPANY_ID
bluearf carbon-uniform list --company-id COMPANY_ID --coid COID
bluearf calculations passenger-commercial-vehicles --company-id COMPANY_ID --coid COID --year 2024
```

## Credit model

Credits are calculated by endpoint and workload. List endpoints reserve by
requested page size and settle by returned rows. Calculation endpoints reserve
and settle by input/output row units. Backend errors are refunded automatically.
