README.md

oscal-diagrams

Automatically generated diagrams for OSCAL models.

About

This project uses erdantic to generate OSCAL model diagrams based on compliance-trestle's pydantic models.

See diagrams for the latest diagrams generated via GitHub Actions.

How to Run

Docker

Make sure you have Docker installed + running and run:

docker build -t oscal-diagrams .
docker run --rm --volume $(pwd)/diagrams:/opt/diagrams oscal-diagrams

This will generate the diagrams into a diagrams folder in the current directory.

Locally

To generate the diagrams locally:

1. Install Conda
2. Install erdantic: conda install -c drivendata erdantic
3. Install compliance-trestle: pip install compliance-trestle
4. Generate the diagrams: ./generate_diagrams.sh

In case you don't want to install erdantic using conda, you can follow the guide in their repository.