Metadata-Version: 2.4
Name: honestroles
Version: 0.1.1
Summary: Deterministic, config-driven job-data runtime with Polars and explicit plugin registries.
Project-URL: Homepage, https://honestroles.com
Project-URL: Repository, https://github.com/hypertrial/honestroles
Project-URL: Issues, https://github.com/hypertrial/honestroles/issues
Project-URL: Documentation, https://honestroles.com/docs/
Author: Hypertrial
License: MIT License
        
        Copyright (c) 2026 Hypertrial
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: data-engineering,jobs,plugin,polars,runtime
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: polars<2.0,>=1.30
Requires-Dist: pydantic<3.0,>=2.10
Requires-Dist: typing-extensions>=4.9
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: hatchling; extra == 'dev'
Requires-Dist: hypothesis; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-xdist; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Provides-Extra: eda
Requires-Dist: matplotlib; extra == 'eda'
Requires-Dist: streamlit; extra == 'eda'
Description-Content-Type: text/markdown

# HonestRoles

HonestRoles is a deterministic, config-driven pipeline runtime for job data with Polars and explicit plugin manifests.

## Start With the App

Use the HonestRoles app first: [honestroles.com](https://honestroles.com).

- Launch app: [https://honestroles.com](https://honestroles.com)
- App guide: [App Quickstart](https://honestroles.com/docs/app/get-started/)

## Choose Your Path

- App users: start in the browser at [honestroles.com](https://honestroles.com)
- Developers and integrators: use the CLI/SDK sections below

## Install (Developer)

```bash
$ python -m venv .venv
$ . .venv/bin/activate
$ python -m pip install --upgrade pip
$ pip install honestroles
```

## 5-Minute First Run (Developer)

From the repository root:

```bash
$ python examples/create_sample_dataset.py
$ honestroles run --pipeline-config examples/sample_pipeline.toml --plugins examples/sample_plugins.toml
$ ls -lh examples/jobs_scored.parquet
```

Expected CLI diagnostics include `stage_rows`, `plugin_counts`, and `final_rows`.

## CLI

```bash
$ honestroles run --pipeline-config pipeline.toml --plugins plugins.toml
$ honestroles plugins validate --manifest plugins.toml
$ honestroles config validate --pipeline pipeline.toml
$ honestroles report-quality --pipeline-config pipeline.toml
$ honestroles scaffold-plugin --name my-plugin --output-dir .
```

## Python API

```python
from honestroles import HonestRolesRuntime

runtime = HonestRolesRuntime.from_configs(
    pipeline_config_path="pipeline.toml",
    plugin_manifest_path="plugins.toml",
)
result = runtime.run()

print(result.diagnostics)
print(result.dataframe.head())
print(result.application_plan[:3])
```

## Documentation

- App home: https://honestroles.com
- Docs home: https://honestroles.com/docs/
- Local docs source: `docs/`
- Start here in docs: `docs/index.md`

## Development

```bash
$ pip install -e ".[dev,docs]"
$ pytest -q
$ pytest tests/docs -q
$ bash scripts/check_docs_refs.sh
```

For local profiling data, keep large parquet inputs under `data/` and write generated artifacts under `dist/` (both are ignored by git).

## License

MIT
