Skip to content

Commit

Permalink
Merge pull request #36 from oscal-compass/refactor/trestle_sdk_examples
Browse files Browse the repository at this point in the history
Refactor trestle_sdk_examples demo
  • Loading branch information
AleJo2995 authored Jul 3, 2024
2 parents 7cf4147 + a615add commit c50976e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This project captures a number of demos, and sample set of content for [compliance-trestle](https://ibm.github.io/compliance-trestle). Each of the folders in the top level of this project is a self contained demonstration.

These demos are designed to work with trestle version 1.0.x
These demos are designed to work with trestle version 3.x.x

## Using / management of this repository

Expand Down
30 changes: 27 additions & 3 deletions trestle_sdk_examples/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,31 @@
# Trestle sdk examples
# Trestle SDK examples

A container for a set of simpler examples of using the trestle sdk.
A container for a set of simpler examples of using the trestle SDK.

## Creating a catalog
## Prerequisites
Download this repo

```
> cd
> mkdir git
> cd git
> git clone https://github.com/oscal-compass/compliance-trestle-demos.git
```

Install compliance trestle, ideally in a python virtual environment.

```
> cd
> python -m venv venv.compliance-trestle-demos
> source venv.compliance-trestle-demos/bin/activate
> cd git/compliance-trestle-demos
> make install
```

## Running the demo
```
> cd trestle_sdk_examples
> python create_a_catalog.py
```

Running `python create_a_catalog.py` will first try and fail to create a catalog (by failing to provide required attributes), then create a catalog, followed by writing it out to disk.

0 comments on commit c50976e

Please sign in to comment.