generated from IBM/repo-template
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #36 from oscal-compass/refactor/trestle_sdk_examples
Refactor trestle_sdk_examples demo
- Loading branch information
Showing
2 changed files
with
28 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |