You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.md
+55-5Lines changed: 55 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,11 +37,61 @@ Trestle provides tooling to help orchestrate the compliance process across a num
37
37
38
38
## Important Note:
39
39
40
-
The current version of trestle supports NIST OSCAL 1.0.0-4. There was a breaking change in OSCAL moving from
41
-
version 1.0.0 to 1.0.2 mainly due to `prop` becoming `props` in AssessmentResults. As a result, the current development path of trestle requires OSCAL 1.0.4, but for those who require OSCAL 1.0.0 please use trestle version 0.37.x. That version is stable but will not have any features added, and we encourage users to move to OSCAL 1.0.4.
40
+
The current version of trestle 3.x supports NIST OSCAL 1.1.2.
41
+
Below shows trestle versions correspondence with OSCAL versions:
42
42
43
-
OSCAL version 1.0.0 files are still handled on import but any AssessmentResults must conform to the OSCAL 1.0.4 schema, with
44
-
props instead of prop. And all files created by trestle will be output as OSCAL version 1.0.4.
43
+
```
44
+
trestle 3.x => OSCAL 1.1.2
45
+
trestle 2.x => OSCAL 1.0.4
46
+
trestle 1.x => OSCAL 1.0.2
47
+
trestle 0.37.x => OSCAL 1.0.0
48
+
```
49
+
50
+
Visit [pypi](https://pypi.org/project/compliance-trestle/#history) for trestle release history and downloads.
51
+
52
+
## Notes for install of current and older versions of trestle
53
+
54
+
#### Install of trestle 3.x
55
+
56
+
Use python 3.11.
57
+
58
+
```
59
+
python3.11 -m venv venv.trestle
60
+
source venv.trestle/bin/activate
61
+
pip install compliance-trestle==3.6.0
62
+
trestle version
63
+
Trestle version v3.6.0 based on OSCAL version 1.1.2
64
+
```
65
+
66
+
#### Install of trestle 2.x
67
+
68
+
Use python 3.9.
69
+
70
+
```
71
+
python3.9 -m venv venv.trestle
72
+
source venv.trestle/bin/activate
73
+
pip install compliance-trestle==2.6.0
74
+
trestle version
75
+
Trestle version v2.6.0 based on OSCAL version 1.0.4
76
+
```
77
+
78
+
#### Install of trestle 1.x
79
+
80
+
Use python 3.9.
81
+
82
+
Due to dependency updates since the release of trestle 1.2.0, perform the following in your venv:
83
+
84
+
```
85
+
python3.9 -m venv venv.trestle
86
+
source venv.trestle/bin/activate
87
+
pip install compliance-trestle==1.2.0
88
+
pip uninstall pydantic
89
+
pip uninstall pydantic_core
90
+
pip install pydantic==1.10.2
91
+
pip install requests
92
+
trestle version
93
+
Trestle version v1.2.0 based on OSCAL version 1.0.2
94
+
```
45
95
46
96
## Why Trestle
47
97
@@ -79,7 +129,7 @@ Trestle runs on most all python platforms (e.g. Linux, Mac, Windows) and is avai
79
129
80
130
## Development status
81
131
82
-
Compliance trestle is currently stable and is based on NIST OSCAL version 1.0.4, with active development continuing.
132
+
Compliance trestle is currently stable and is based on NIST OSCAL version 1.1.2, with active development continuing.
0 commit comments