https://github.com/cyght-io/oscal-diagrams

Automatically generated diagrams for OSCAL models
https://github.com/cyght-io/oscal-diagrams

diagrams oscal pydantic

Last synced: 2 months ago
JSON representation

Automatically generated diagrams for OSCAL models

• Host: GitHub
• URL: https://github.com/cyght-io/oscal-diagrams
• Owner: cyght-io
• License: apache-2.0
• Created: 2022-01-18T12:17:14.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-12T15:54:19.000Z (almost 3 years ago)
• Last Synced: 2024-08-02T18:38:59.895Z (6 months ago)
• Topics: diagrams, oscal, pydantic
• Language: Shell
• Homepage:
• Size: 23 MB
• Stars: 14
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-oscal - oscal-diagrams

README

        
# oscal-diagrams

Automatically generated diagrams for [OSCAL](https://github.com/usnistgov/OSCAL/) models.

    

## About

This project uses [erdantic](https://github.com/drivendataorg/erdantic) to generate [OSCAL](https://github.com/usnistgov/OSCAL/) model diagrams based on [compliance-trestle](https://github.com/IBM/compliance-trestle)'s [pydantic](https://github.com/samuelcolvin/pydantic) models.

See [diagrams](diagrams) for the latest diagrams generated via GitHub Actions.

## How to Run

### Docker

Make sure you have [Docker](https://www.docker.com/) installed + running and run:

```bash

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](https://docs.conda.io/projects/conda/en/latest/user-guide/install/)

2. Install [erdantic](https://github.com/drivendataorg/erdantic): `conda install -c drivendata erdantic`

3. Install [compliance-trestle](https://github.com/IBM/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](https://github.com/drivendataorg/erdantic#installation) in their repository.