Skip to content

docs: align Arbiter install package name #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hummbl-dev merged 1 commit into from
May 14, 2026
Merged

docs: align Arbiter install package name #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Arbiter

[![CI](https://github.com/hummbl-dev/arbiter/actions/workflows/ci.yml/badge.svg)](https://github.com/hummbl-dev/arbiter/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/arbiter)](https://pypi.org/project/arbiter/)
[![PyPI](https://img.shields.io/pypi/v/arbiter-score)](https://pypi.org/project/arbiter-score/)
[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
[![Dependencies](https://img.shields.io/badge/core_deps-stdlib_only-brightgreen)]()
Expand All @@ -14,9 +14,12 @@ Repository health, validation, and stewardship expectations are tracked in [docs

## Install

The Python distribution is `arbiter-score`; the installed CLI command is `arbiter`.
Do not install the separate PyPI project named `arbiter` for this tool.

```bash
pip install arbiter # core (stdlib only)
pip install "arbiter[analyzers]" # + ruff, radon, vulture, bandit
pip install arbiter-score # core (stdlib only)
pip install "arbiter-score[analyzers]" # + ruff, radon, vulture, bandit

# Or from source
git clone https://github.com/hummbl-dev/arbiter.git && cd arbiter
Expand Down
1 change: 1 addition & 0 deletions docs/REPO_HEALTH.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Branch protection is tracked centrally in `hummbl-dev/hummbl-dev#18`; do not ove

- The core package should remain usable without analyzer extras; analyzer-specific integrations belong behind optional extras.
- Public install instructions must match `pyproject.toml` package metadata and published distribution names.
- `arbiter-score` is the intended public distribution name; `arbiter` is only the installed CLI entry point for this repository and should not be documented as the PyPI package.
- Self-grade and reusable quality-gate thresholds are product contracts, not decorative metrics.
- Changes to scoring formulas, analyzer weights, noise thresholds, or agent attribution should include before/after evidence.
- Generated scoring artifacts such as local JSONL audit files should not be treated as source-of-truth documentation unless explicitly committed by design.
Expand Down
Loading