From a450cc4d7692e7b358e91682d9eebcdd5857afd0 Mon Sep 17 00:00:00 2001 From: Ma1h01 Date: Wed, 26 Jun 2024 12:00:25 -0400 Subject: [PATCH 1/3] refactor: update the trestle version to 3.0.x in the repo README Signed-off-by: Ma1h01 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 724eb1e..113f96a 100644 --- a/README.md +++ b/README.md @@ -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.0.x ## Using / management of this repository From a2e3a2e1536870a0c531f268a06c89df56c78afe Mon Sep 17 00:00:00 2001 From: Ma1h01 Date: Wed, 26 Jun 2024 12:10:14 -0400 Subject: [PATCH 2/3] refactor: include prerequisite step in the README Signed-off-by: Ma1h01 --- trestle_sdk_examples/README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/trestle_sdk_examples/README.md b/trestle_sdk_examples/README.md index 7db71ca..0b611c8 100644 --- a/trestle_sdk_examples/README.md +++ b/trestle_sdk_examples/README.md @@ -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. From a615add3747e7d5a0f6a0532827bc1df424db5e2 Mon Sep 17 00:00:00 2001 From: Ma1h01 Date: Wed, 26 Jun 2024 13:58:18 -0400 Subject: [PATCH 3/3] refator: update the trestle version in repo README Signed-off-by: Ma1h01 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 113f96a..3674afa 100644 --- a/README.md +++ b/README.md @@ -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 3.0.x +These demos are designed to work with trestle version 3.x.x ## Using / management of this repository