Start here
Install
ruleprobe is one package on PyPI. Run it without installing anything, install it as a command, or import it as a library.
Run it
uvx runs the latest release in a throwaway environment and leaves nothing installed.
Run the latest releasesh
uvx ruleprobe reportInstall it
pipx puts the ruleprobe command on your path, in an environment of its own.
As a commandsh
pipx install ruleprobe
ruleprobe reportpip installs it into the environment you are in, for use as a library.
As a librarysh
pip install ruleprobePin a version
Every example on this site comes from v0.1.0. To run exactly that release:
ruleprobe 0.1.0sh
uvx ruleprobe@0.1.0 --version
It needs Python >=3.9 and nothing outside the standard library,
as the release's pyproject.toml declares.
Development
git clone https://github.com/JakeSelby/ruleprobe && cd ruleprobe
python3 -m unittest discover -s tests
uv run --python 3.9 python -m unittest discover -s tests # the floor the package claims
python3 -m compileall ruleprobe
python3 -m ruleprobe report --root tests/fixtures
python3 -m ruleprobe report --root docs --rules docs/rules
python3 -m ruleprobe corpus --floor 0.9 # the corpus gate CI runs