Metadata-Version: 2.4
Name: truero
Version: 0.2.5
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
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.

Run data-quality and ML validation checks on your machine, then optionally upload the **report** (not your raw file) to the [Truero dashboard](https://dashboard.truero.ai).

## Prerequisites & Python Setup

- **Python Version**: **Python 3.11+ is recommended** (Python 3.10+ supported).
- **macOS Note**: Avoid the default system Python 3.9 (its bundled LibreSSL causes SSL warnings and syntax incompatibilities with modern libraries). Use Homebrew Python (`brew install python@3.11`), `pyenv`, or `pipx`.

### Need to install Python 3.11?

| OS | Recommended Method | Command / Link |
|---|---|---|
| **macOS** | Homebrew / Official PKG | • `brew install python@3.11` ([Homebrew](https://brew.sh/))<br>• [Official macOS Installer](https://www.python.org/downloads/macos/) |
| **Windows** | Official Installer / Winget | • [Official Windows Installer](https://www.python.org/downloads/windows/) *(Check "Add python.exe to PATH")*<br>• `winget install Python.Python.3.11`<br>• [Microsoft Store Python 3.11](https://apps.microsoft.com/detail/9nr50h2988sf) |
| **Linux (Ubuntu/Debian)** | APT | `sudo apt update && sudo apt install python3.11 python3.11-venv python3-pip` |
| **Linux (Fedora/RHEL)** | DNF | `sudo dnf install python3.11 python3.11-pip` |
| **Cross-Platform / Fast** | `uv` / `pyenv` | • [astral.sh/uv](https://astral.sh/uv) (`uv python install 3.11`)<br>• [github.com/pyenv/pyenv](https://github.com/pyenv/pyenv) (`pyenv install 3.11`) |

---

## Install

**Recommended (Isolated CLI via pipx):**

```bash
pipx install truero
```

**With Python 3.11+ directly:**

```bash
python3.11 -m pip install --upgrade truero
```

**In a virtual environment:**

```bash
python3.11 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
python -m pip install --upgrade truero
```

## Quick start

In the same environment where you installed Truero:

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

Supported files: CSV, JSON, Excel (`.xlsx` / `.xls`), Parquet.

Optional browser wizard (same checks, GUI):

```bash
truero web
```

## Upload to the dashboard

After a scan, the CLI asks:

```text
Upload report to Truero dashboard? [Y/n]:
```

1. Type `Y` (or press Enter) to upload, or `n` to skip.
2. If you have not saved a User ID yet, enter it when prompted — copy it from Dashboard → Settings (Profile).
3. You can save the ID for future runs (`~/.truero/config.json`). After that you will not be asked again until you change or reset it.

You can also set the User ID up front:

```bash
# Environment variable
TRUERO_USER_ID=YOUR-UUID-HERE truero scan data.csv

# Or flag
truero scan data.csv --user-id YOUR-UUID-HERE

# Or save once
truero config set-user YOUR-UUID-HERE
```

Skip the upload prompt entirely:

```bash
truero scan data.csv --no-upload
```

Upload sends the **report summary** only — never your raw dataset.

## Optional configuration

| Flag / env | Purpose |
|------------|---------|
| `--user-id` / `TRUERO_USER_ID` | Dashboard User ID (UUID) for uploads |
| `--no-upload` | Skip dashboard upload prompt |
| `TRUERO_API_URL` | Override backend URL (default: hosted Railway API) |
| `TRUERO_DASHBOARD_URL` | Dashboard base URL (default: `https://dashboard.truero.ai`) |
| `--api-key` / `TRUERO_API_KEY` | Internal/dev only — not required for normal installs |

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

## Useful commands

```bash
truero scan path/to/file.csv
truero web
truero config show
truero config set-user YOUR-UUID-HERE
```

## Links

- Website: https://www.truero.ai  
- Dashboard: https://dashboard.truero.ai  
