Installation¶

Via pip (recommended)¶

pip install crunch-uml

After installation, the crunch_uml command is available:

crunch_uml --help

From source code¶

git clone https://github.com/brienen/crunch_uml.git
cd crunch_uml
pip install -e .

Or run directly from source:

python ./crunch_uml/cli.py --help

Requirements¶

Python 3.9, 3.10, 3.11 or 3.12
Dependencies are installed automatically (SQLAlchemy, lxml, pandas, etc.)

Database¶

By default crunch_uml uses a SQLite database in the current directory (crunch_uml.db). You can use any SQLAlchemy-compatible database:

# SQLite (default)
crunch_uml -db_url sqlite:///my_model.db import -f model.xmi -t eaxmi

# PostgreSQL
crunch_uml -db_url postgresql://user:pass@localhost/crunch import -f model.xmi -t eaxmi

First test¶

Check if the installation works:

# Import an XMI file and create a new database
crunch_uml import -f your_model.xmi -t eaxmi -db_create

# View the result as Excel
crunch_uml export -t xlsx -f output.xlsx