Metadata-Version: 2.4
Name: statline
Version: 3.0.0
Summary: StatLine — weighted player scoring, efficiency modeling, CLI + adapter tooling
Project-URL: Homepage, https://statline.dev
Project-URL: Repository, https://github.com/amillolive/StatLine
Project-URL: Issues, https://github.com/amillolive/StatLine/issues
Project-URL: Legal, https://github.com/amillolive/StatLine/tree/main/legal
Author: StatLine LLC
License: # StatLine – Weighted Player Scoring and Analytics
        
        Copyright (C) 2026 StatLine LLC (in formation)
        
        This program is free software: you can redistribute it and/or modify
        it under the terms of the GNU Affero General Public License as published
        by the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.
        
        As an additional condition, you may not use the name “StatLine” or any
        confusingly similar mark in connection with your distribution, hosting,
        or marketing of this software without express written permission from
        the copyright holder. This restriction is to protect the StatLine brand
        and avoid confusion between official and unofficial versions.
        
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU Affero General Public License for more details.
        
        You should have received a copy of the GNU Affero General Public License
        along with this program.  If not, see <https://www.gnu.org/licenses/>.
        
        ---
        
        Additional Terms (Trademark)
        
        "StatLine" and associated logos are trademarks of StatLine LLC (in formation), trademark registration pending.  
        This license does not grant you any rights to use the StatLine name or branding without prior written permission, except for fair use when referring to the project. Any fork, derivative work, or public deployment must remove the StatLine trademark unless explicitly authorized under our Trademark Policy.
License-File: LICENSE
Keywords: adapters,analytics,basketball,cli,efg,esports,mvp,pri,slapi,statline
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: <3.15,>=3.10
Requires-Dist: click<9.0,>=8.1
Requires-Dist: httpx<1.0,>=0.27
Requires-Dist: pyyaml<7.0,>=6.0
Requires-Dist: typer<1.0,>=0.12
Requires-Dist: typing-extensions>=4.7; python_version < '3.15'
Provides-Extra: devpack
Requires-Dist: build<2.0,>=1.2; extra == 'devpack'
Requires-Dist: coverage[toml]<8.0,>=7.5; extra == 'devpack'
Requires-Dist: cryptography<47.0,>=42.0; extra == 'devpack'
Requires-Dist: fastapi<1.0,>=0.110; extra == 'devpack'
Requires-Dist: google-auth<3.0,>=2.0; extra == 'devpack'
Requires-Dist: gspread<7.0,>=6.0; extra == 'devpack'
Requires-Dist: hypothesis<7.0,>=6.100; extra == 'devpack'
Requires-Dist: mkdocs-material<10.0,>=9.5; extra == 'devpack'
Requires-Dist: mkdocstrings[python]<1.0,>=0.25; extra == 'devpack'
Requires-Dist: mypy<2.0,>=1.11; extra == 'devpack'
Requires-Dist: pip-audit<3.0,>=2.7; extra == 'devpack'
Requires-Dist: pydantic<3.0,>=2.6; extra == 'devpack'
Requires-Dist: pyright<2.0,>=1.1.370; extra == 'devpack'
Requires-Dist: pytest-cov<7.0,>=4.1; extra == 'devpack'
Requires-Dist: pytest<9.0,>=8.1; extra == 'devpack'
Requires-Dist: rich<15.0,>=13.0; extra == 'devpack'
Requires-Dist: ruff<1.0,>=0.5; extra == 'devpack'
Requires-Dist: textual<9.0,>=8.0; extra == 'devpack'
Requires-Dist: twine<7.0,>=5.0; extra == 'devpack'
Requires-Dist: types-pyyaml>=6.0.12; extra == 'devpack'
Requires-Dist: types-requests>=2.32; extra == 'devpack'
Requires-Dist: uvicorn[standard]<1.0,>=0.30; extra == 'devpack'
Provides-Extra: extras
Requires-Dist: cryptography<47.0,>=42.0; extra == 'extras'
Requires-Dist: fastapi<1.0,>=0.110; extra == 'extras'
Requires-Dist: google-auth<3.0,>=2.0; extra == 'extras'
Requires-Dist: gspread<7.0,>=6.0; extra == 'extras'
Requires-Dist: pydantic<3.0,>=2.6; extra == 'extras'
Requires-Dist: rich<15.0,>=13.0; extra == 'extras'
Requires-Dist: textual<9.0,>=8.0; extra == 'extras'
Requires-Dist: uvicorn[standard]<1.0,>=0.30; extra == 'extras'
Provides-Extra: remote
Requires-Dist: cryptography<47.0,>=42.0; extra == 'remote'
Requires-Dist: fastapi<1.0,>=0.110; extra == 'remote'
Requires-Dist: pydantic<3.0,>=2.6; extra == 'remote'
Requires-Dist: uvicorn[standard]<1.0,>=0.30; extra == 'remote'
Description-Content-Type: text/markdown

# StatLine

**StatLine** is an adapter-driven player scoring and analytics toolkit for turning raw stat rows into weighted, explainable ratings.

It can run completely local for simple scoring workflows, or against **SLAPI**, the optional StatLine API layer for authenticated remote scoring, adapter inspection, and multi-client deployments.

> Release target: **v3.0.0**  
> Python: **3.10 through 3.14**  
> License: **AGPL-3.0-or-later**, with separate trademark restrictions for the StatLine name and branding.

---

## What StatLine does

StatLine takes raw rows like CSV box-score data, maps those rows through an adapter, scores the mapped metrics, then returns profile scores such as **PRI** and adapter-defined variants.

At a high level, StatLine provides:

- **Adapter-based scoring** for different games, leagues, datasets, or stat schemas.
- **Local scoring** through the Python package and `statline` CLI.
- **Remote/API scoring** through SLAPI when installed with the remote stack.
- **Weighted score profiles**, including PRI-style outputs and adapter-defined variants.
- **Batch scoring**, row scoring, mapping-only commands, and already-mapped calculation commands.
- **Adapter inspection tools** for inputs, metrics, dimensions, filters, weights, and sniffing.
- **Typed public Python API** for bots, dashboards, notebooks, and application code.

---

## Install

StatLine v3.0.0 has four intended install variants.

| Variant | Command | Use this when you want |
| --- | --- | --- |
| **base** | `pip install statline` | Functional local library and local CLI scoring. |
| **remote** | `pip install "statline[remote]"` | Base plus API client/auth and the SLAPI serving stack. |
| **extras** | `pip install "statline[extras]"` | Remote plus user conveniences such as richer terminal/UI and Google Sheets-related helpers. |
| **devpack** | `pip install -e ".[devpack]"` | Everything needed for development, testing, typing, docs, packaging, and release checks. |

For a source checkout:

```bash
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
python -m pip install --upgrade pip
python -m pip install -e ".[devpack]"
```

---

## Quick start: local CLI

Local mode avoids all network probing and uses the installed StatLine core directly.

```bash
statline --mode local adapter list
statline --mode local adapter inputs demo
statline --mode local adapter weights demo
```

Score the bundled demo CSV from a source checkout:

```bash
statline --mode local score \
  --adapter demo \
  statline/data/stats/DEMO/demo.csv \
  --fmt table \
  --profile all \
  --percentile \
  --limit 10
```

Write JSON instead:

```bash
statline --mode local score \
  --adapter demo \
  statline/data/stats/DEMO/demo.csv \
  --fmt json \
  --pretty \
  --out results.json
```

---

## Quick start: Python API

```python
from statline import list_adapters, load_dataset, score

print(list_adapters())

rows = load_dataset("DEMO/demo", limit=10)
results = score("demo", rows, mode="batch", weights="pri")

for row in results[:3]:
    print(row["pri"], row["pri_raw"], row.get("scores", {}))
```

For one row:

```python
from statline import score_row

player = {
    "name": "Example Player",
    "ppg": 24.5,
    "apg": 6.2,
    "orpg": 1.0,
    "drpg": 4.0,
    "spg": 1.5,
    "bpg": 0.7,
    "tov": 2.1,
    "fgm": 9.2,
    "fga": 18.4,
    "win": 12,
    "loss": 8,
}

result = score_row("demo", player, weights="pri")
print(result["pri"])
```

---

## CLI overview

The main command is:

```bash
statline --help
```

Useful global options:

| Option | Meaning |
| --- | --- |
| `--mode auto` | Probe SLAPI; use remote when reachable and authenticated, otherwise local where supported. |
| `--mode local` | Force offline local scoring and skip SLAPI entirely. |
| `--mode remote` | Require SLAPI to be reachable and authenticated. |
| `--url URL` | Set the SLAPI base URL. Also supported through `SLAPI_URL`. |
| `--timing / --no-timing` | Show or hide timing summaries. |
| `--version` | Print the CLI version. |

Primary user commands:

| Command | Purpose |
| --- | --- |
| `statline adapter list` | List adapters. |
| `statline adapter spec <adapter>` | Show adapter metadata/spec details. |
| `statline adapter inputs <adapter>` | Show raw input keys expected by an adapter. |
| `statline adapter metrics <adapter>` | Show mapped metric keys. |
| `statline adapter weights <adapter>` | Show available weight profiles. |
| `statline adapter filters <adapter>` | Show adapter-declared filters. |
| `statline adapter sniff --file stats.csv` | Detect matching adapters from headers. |
| `statline map row` / `map batch` | Map raw rows without scoring. |
| `statline calc row` / `calc batch` | Score already-mapped metric rows. |
| `statline score` | Map and score raw CSV/YAML/JSON rows. |
| `statline interactive` | Guided CLI scoring flow. |
| `statline serve` | Start SLAPI locally. Requires the remote stack. |
| `statline auth ...` | Device enrollment and API key workflows. |
| `statline sys status` | Runtime, auth, path, and logging status. |

---

## Scoring concepts

### Adapter

An adapter is a YAML contract that explains how to turn raw fields into StatLine metrics. It defines:

- metadata such as `key`, `version`, `aliases`, and `title`,
- raw-to-metric mappings,
- derived efficiency metrics,
- buckets,
- weight profiles,
- penalties,
- score profiles,
- optional dimensions and filters,
- optional sniffing rules for adapter detection.

### Metric

A metric is a numeric signal used by the scoring engine. Metrics can be direct fields, constants, or safe expressions over previous values.

### Bucket

A bucket groups metrics for weighting. A PRI profile does not usually weight every metric one by one; it weights the buckets.

### Weight profile

A weight profile defines how strongly each bucket contributes. The default profile is usually `pri`, but adapters can expose more.

### Score profile

A score profile controls how the normalized raw score becomes a published score. StatLine supports affine profiles and windowed profiles.

### PRI and `pri_raw`

`pri_raw` is the normalized raw score. `pri` is the adapter/profile-rendered score. Some adapters also expose additional profile scores such as `pri_af`, `pri_ar`, or `pri_ap`.

---

## Input formats

The CLI reads CSV, YAML, JSON-like YAML, and stdin CSV for commands that accept file input.

CSV example:

```csv
name,ppg,apg,orpg,drpg,spg,bpg,tov,fgm,fga,win,loss
Example Player,24.5,6.2,1.0,4.0,1.5,0.7,2.1,9.2,18.4,12,8
```

YAML example:

```yaml
- name: Example Player
  ppg: 24.5
  apg: 6.2
  orpg: 1.0
  drpg: 4.0
  spg: 1.5
  bpg: 0.7
  tov: 2.1
  fgm: 9.2
  fga: 18.4
  win: 12
  loss: 8
```

---

## Remote/API mode

Install the remote variant:

```bash
pip install "statline[remote]"
```

Start SLAPI locally:

```bash
statline --mode local serve --host 127.0.0.1 --port 8000
```

Or use the `slapi` console entry point:

```bash
SLAPI_HOST=127.0.0.1 SLAPI_PORT=8000 slapi
```

Then point clients at it:

```bash
export SLAPI_URL="http://127.0.0.1:8000"
statline --mode remote sys status
```

SLAPI supports protected auth flows. Normal remote use requires both device enrollment and an API key. Administrative and moderation commands require the matching scopes.

Common auth flow:

```bash
statline auth device-init
statline auth enroll --token reg_... --user your-handle --email you@example.com
statline auth apikey-request --owner your-name
statline auth apikey-claim --request-id REQUEST_ID
statline auth whoami
```

The exact approval steps depend on the SLAPI administrator.

---

## Development

Install the development pack:

```bash
python -m pip install -e ".[devpack]"
```

Run checks:

```bash
pytest
ruff check statline tests
mypy statline
pyright
```

---

## Legal

StatLine source code is licensed under the **GNU Affero General Public License v3 or later**. The StatLine name, marks, and logos are not granted by the source license.

See:

- `LICENSE`
- `TRADEMARK_POLICY.md`
- `CLA.md`
- `legal/tos.md`
- `legal/privacypolicy.md`
- `legal/aup.md`

---

## Repository

- Homepage: `https://statline.dev`
- Repository: `https://github.com/amillolive/StatLine`
- Issues: `https://github.com/amillolive/StatLine/issues`
