Metadata-Version: 2.4
Name: slicks
Version: 0.2.0
Summary: The home baked data pipeline for Western Formula Racing
Author-email: Western Formula Racing <fsae.uwo@gmail.com>
Project-URL: Homepage, https://github.com/Western-Formula-Racing/wfr-telemetry
Project-URL: Documentation, https://western-formula-racing.github.io/wfr-telemetry/
Project-URL: Bug Tracker, https://github.com/Western-Formula-Racing/wfr-telemetry/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: pandas>=2.0.0
Requires-Dist: influxdb3-python>=0.1.0
Requires-Dist: influxdb-client>=1.30.0
Requires-Dist: cantools>=39.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: matplotlib>=3.0.0
Requires-Dist: tqdm>=4.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: interrogate>=1.5.0; extra == "dev"

# Slicks

[![CI](https://github.com/Western-Formula-Racing/wfr-telemetry/actions/workflows/ci.yml/badge.svg)](https://github.com/Western-Formula-Racing/wfr-telemetry/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/Western-Formula-Racing/wfr-telemetry/branch/main/graph/badge.svg)](https://codecov.io/gh/Western-Formula-Racing/wfr-telemetry)
[![interrogate](https://raw.githubusercontent.com/Western-Formula-Racing/wfr-telemetry/main/interrogate_badge.svg)](https://interrogate.readthedocs.io/)

The home baked data pipeline for **Western Formula Racing**.

This package handles:
1. **Data Ingestion:** Reliable fetching from InfluxDB 3.0.
2. **Movement Detection:** Smart filtering of "Moving" vs "Idle" car states.
3. **Sensor Discovery:** Tools to explore available sensors on any given race day.

## Documentation

- **[Full Documentation](https://western-formula-racing.github.io/wfr-telemetry/)**
- **[Getting Started](docs/getting_started.md):** Installation and your first script.
- **[API Reference](docs/api_reference.md):** Detailed function documentation.
- **[Advanced Usage](docs/advanced_usage.md):** Configuration, Discovery, and Bulk Exports.

## Installation

Now available on PyPI!

```bash
pip install slicks
```

## Quick Example

```python
import slicks
from datetime import datetime

# 1. Connect (Auto-configured or custom)
slicks.connect_influxdb3(db="WFR25")

# 2. Fetch Data (One-liner)
df = slicks.fetch_telemetry(
    datetime(2025, 9, 28), 
    datetime(2025, 9, 30), 
    "INV_Motor_Speed"
)

print(df.describe())
```

See [Getting Started](docs/getting_started.md) for more details.
