Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor trestle_sdk_examples demo #36

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Refactor trestle_sdk_examples demo #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a450cc4
refactor: update the trestle version to 3.0.x in the repo README
Ma1h01 Jun 26, 2024
a2e3a2e
refactor: include prerequisite step in the README
Ma1h01 Jun 26, 2024
a615add
refator: update the trestle version in repo README
Ma1h01 Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
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
View file
Open in desktop
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.
Loading