Metadata-Version: 2.4
Name: truero
Version: 0.2.2
Summary: Understand and clean your data before it causes problems
Home-page: https://github.com/Thisizzellie/Truero
Author: Truero
Author-email: hello@truero.ai
License: Proprietary
Project-URL: Homepage, https://www.truero.ai
Project-URL: Dashboard, https://dashboard.truero.ai
Project-URL: Source, https://github.com/Thisizzellie/Truero
Keywords: ml data-quality validation bias audit cli
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
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: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: click>=8.0
Requires-Dist: requests>=2.28
Requires-Dist: rich>=13.0
Requires-Dist: pandas>=1.5
Requires-Dist: numpy>=1.23
Requires-Dist: flask>=3.0
Requires-Dist: openpyxl>=3.0
Requires-Dist: pyarrow>=10.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Truero CLI

Understand and clean your data before it causes problems.

## Install

```bash
pip install truero
```

No API key or account is required — run a scan immediately:

```bash
truero scan data.csv
truero web
```

Cleaning checks run on your machine. ML checks use the hosted Truero API automatically.

## Optional configuration

| Flag / env | Purpose |
|------------|---------|
| `--user-id` / `TRUERO_USER_ID` | Supabase auth UUID — only needed to **upload** reports to your dashboard |
| `--no-upload` | Skip dashboard upload prompt |
| `TRUERO_API_URL` | Override backend URL (default: hosted API; monorepo dev uses `http://localhost:8001`) |
| `TRUERO_DASHBOARD_URL` | Dashboard base URL (default: `https://dashboard.truero.ai`) |
| `--api-key` / `TRUERO_API_KEY` | Internal/dev only — not required for normal `pip install` users |

You can also set API/dashboard URLs in the web wizard Settings, or in `~/.truero/config.json` (`web_api_url`, `web_dashboard_url`).

## Notes

- Upload sends the **report** to the backend so it appears in the dashboard (not your raw CSV).
- Supported file types: CSV, JSON, Excel (`.xlsx`/`.xls`), Parquet.
- First run prompts you to accept the Terms & Conditions (or pass `--accept-terms`).
