Install

There is no pip package yet. You run modelaudit from a clone of the repository.

Requirements

• Python 3.8 or newer. CI runs the test suite on 3.8 through 3.13, on Linux.
• git, to clone the repository.
• No third-party packages. Everything is in Python's standard library (argparse, json, os, re, urllib, dataclasses).
• Network access is optional. See --offline.

Clone and run

git clone https://github.com/nicedreamzapp/modelaudit
cd modelaudit
python3 -m modelaudit --help

python3 -m modelaudit works from the repository folder because the package lives in the modelaudit/ directory there.

Run it from anywhere

Put the repository on PYTHONPATH:

export PYTHONPATH="$HOME/src/modelaudit:$PYTHONPATH"   # wherever you cloned it
python3 -m modelaudit ~/MyProject

Or add a shell alias:

alias modelaudit='PYTHONPATH="$HOME/src/modelaudit" python3 -m modelaudit'

Update

cd modelaudit
git pull

Uninstall

Delete the cloned folder. The tool writes no files, caches or config anywhere on disk.

Next

Go to the Quickstart.