Deployed 8e7c490 with MkDocs version: 1.5.0

api_reference/trestle.oscal.common/index.html

@@ -45380,9 +45380,9 @@ <h4 id="trestle.oscal.common.AtFrequency" class="doc doc-heading">
     <span class="k">class</span> <span class="nc">Config</span><span class="p">:</span>
         <span class="n">extra</span> <span class="o">=</span> <span class="n">Extra</span><span class="o">.</span><span class="n">forbid</span>
 
-    <span class="n">period</span><span class="p">:</span> <span class="n">PositiveIntegerDatatype</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
-        <span class="o">...</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">&#39;The task must occur after the specified period has elapsed.&#39;</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s1">&#39;Period&#39;</span>
-    <span class="p">)</span>
+    <span class="n">period</span><span class="p">:</span> <span class="n">conint</span><span class="p">(</span>
+        <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">multiple_of</span><span class="o">=</span><span class="mi">1</span>
+    <span class="p">)</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">&#39;The task must occur after the specified period has elapsed.&#39;</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s1">&#39;Period&#39;</span><span class="p">)</span>
     <span class="n">unit</span><span class="p">:</span> <span class="n">TimeUnitValidValues</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">&#39;The unit of time for the period.&#39;</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s1">&#39;Time Unit&#39;</span><span class="p">)</span>
 </code></pre></div>
         </details>
@@ -45674,7 +45674,7 @@ <h6 id="trestle.oscal.common.AtFrequency.__validators__" class="doc doc-heading"
 
 
 <h6 id="trestle.oscal.common.AtFrequency.period" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">period</span><span class="p">:</span> <span class="n">PositiveIntegerDatatype</span></code>
+<code class="highlight language-python"><span class="n">period</span><span class="p">:</span> <span class="n">ConstrainedIntValue</span></code>
 
   <span class="doc doc-properties">
       <small class="doc doc-property doc-property-pydantic-field"><code>pydantic-field</code></small>
@@ -70075,10 +70075,10 @@ <h4 id="trestle.oscal.common.PortRange" class="doc doc-heading">
     <span class="k">class</span> <span class="nc">Config</span><span class="p">:</span>
         <span class="n">extra</span> <span class="o">=</span> <span class="n">Extra</span><span class="o">.</span><span class="n">forbid</span>
 
-    <span class="n">start</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">NonNegativeIntegerDatatype</span><span class="p">]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
+    <span class="n">start</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">conint</span><span class="p">(</span><span class="n">ge</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">multiple_of</span><span class="o">=</span><span class="mi">1</span><span class="p">)]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
         <span class="kc">None</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">&#39;Indicates the starting port number in a port range&#39;</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s1">&#39;Start&#39;</span>
     <span class="p">)</span>
-    <span class="n">end</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">NonNegativeIntegerDatatype</span><span class="p">]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
+    <span class="n">end</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">conint</span><span class="p">(</span><span class="n">ge</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">multiple_of</span><span class="o">=</span><span class="mi">1</span><span class="p">)]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
         <span class="kc">None</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">&#39;Indicates the ending port number in a port range&#39;</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s1">&#39;End&#39;</span>
     <span class="p">)</span>
     <span class="n">transport</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">PortRangeValidValues</span><span class="p">]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
@@ -70374,7 +70374,7 @@ <h6 id="trestle.oscal.common.PortRange.__validators__" class="doc doc-heading">
 
 
 <h6 id="trestle.oscal.common.PortRange.end" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">end</span><span class="p">:</span> <span class="n">NonNegativeIntegerDatatype</span></code>
+<code class="highlight language-python"><span class="n">end</span><span class="p">:</span> <span class="n">ConstrainedIntValue</span></code>
 
   <span class="doc doc-properties">
       <small class="doc doc-property doc-property-pydantic-field"><code>pydantic-field</code></small>
@@ -70396,7 +70396,7 @@ <h6 id="trestle.oscal.common.PortRange.end" class="doc doc-heading">
 
 
 <h6 id="trestle.oscal.common.PortRange.start" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">start</span><span class="p">:</span> <span class="n">NonNegativeIntegerDatatype</span></code>
+<code class="highlight language-python"><span class="n">start</span><span class="p">:</span> <span class="n">ConstrainedIntValue</span></code>
 
   <span class="doc doc-properties">
       <small class="doc doc-property doc-property-pydantic-field"><code>pydantic-field</code></small>

api_reference/trestle.tasks.csv_to_oscal_cd/index.html

@@ -3953,6 +3953,13 @@
     <nav class="md-nav" aria-label="csv_to_oscal_cd">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#trestle.tasks.csv_to_oscal_cd.ADJUSTED_RISK_RATING" class="md-nav__link">
+    ADJUSTED_RISK_RATING
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#trestle.tasks.csv_to_oscal_cd.CHECK_DESCRIPTION" class="md-nav__link">
     CHECK_DESCRIPTION
@@ -4021,6 +4028,13 @@
     NAMESPACE
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#trestle.tasks.csv_to_oscal_cd.ORIGINAL_RISK_RATING" class="md-nav__link">
+    ORIGINAL_RISK_RATING
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -4070,6 +4084,13 @@
     PROFILE_SOURCE
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#trestle.tasks.csv_to_oscal_cd.RISK_ADJUSTMENT" class="md-nav__link">
+    RISK_ADJUSTMENT
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -4922,6 +4943,13 @@
     <nav class="md-nav" aria-label="csv_to_oscal_cd">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#trestle.tasks.csv_to_oscal_cd.ADJUSTED_RISK_RATING" class="md-nav__link">
+    ADJUSTED_RISK_RATING
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#trestle.tasks.csv_to_oscal_cd.CHECK_DESCRIPTION" class="md-nav__link">
     CHECK_DESCRIPTION
@@ -4990,6 +5018,13 @@
     NAMESPACE
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#trestle.tasks.csv_to_oscal_cd.ORIGINAL_RISK_RATING" class="md-nav__link">
+    ORIGINAL_RISK_RATING
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -5039,6 +5074,13 @@
     PROFILE_SOURCE
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#trestle.tasks.csv_to_oscal_cd.RISK_ADJUSTMENT" class="md-nav__link">
+    RISK_ADJUSTMENT
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -5424,6 +5466,24 @@ <h2 id="trestle.tasks.csv_to_oscal_cd" class="doc doc-heading">
 
 
 
+  <div class="doc doc-object doc-attribute">
+
+
+
+<h4 id="trestle.tasks.csv_to_oscal_cd.ADJUSTED_RISK_RATING" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">ADJUSTED_RISK_RATING</span></code>
+
+
+<a href="#trestle.tasks.csv_to_oscal_cd.ADJUSTED_RISK_RATING" class="headerlink" title="Permanent link">¤</a></h4>
+
+    <div class="doc doc-contents ">
+
+    </div>
+
+  </div>
+
+
+
   <div class="doc doc-object doc-attribute">
 
 
@@ -5608,6 +5668,24 @@ <h4 id="trestle.tasks.csv_to_oscal_cd.NAMESPACE" class="doc doc-heading">
 
 
 
+<h4 id="trestle.tasks.csv_to_oscal_cd.ORIGINAL_RISK_RATING" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">ORIGINAL_RISK_RATING</span></code>
+
+
+<a href="#trestle.tasks.csv_to_oscal_cd.ORIGINAL_RISK_RATING" class="headerlink" title="Permanent link">¤</a></h4>
+
+    <div class="doc doc-contents ">
+
+    </div>
+
+  </div>
+
+
+
+  <div class="doc doc-object doc-attribute">
+
+
+
 <h4 id="trestle.tasks.csv_to_oscal_cd.PARAMETER" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">PARAMETER</span></code>
 
@@ -5734,6 +5812,24 @@ <h4 id="trestle.tasks.csv_to_oscal_cd.PROFILE_SOURCE" class="doc doc-heading">
 
 
 
+<h4 id="trestle.tasks.csv_to_oscal_cd.RISK_ADJUSTMENT" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">RISK_ADJUSTMENT</span></code>
+
+
+<a href="#trestle.tasks.csv_to_oscal_cd.RISK_ADJUSTMENT" class="headerlink" title="Permanent link">¤</a></h4>
+
+    <div class="doc doc-contents ">
+
+    </div>
+
+  </div>
+
+
+
+  <div class="doc doc-object doc-attribute">
+
+
+
 <h4 id="trestle.tasks.csv_to_oscal_cd.RULE_DESCRIPTION" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">RULE_DESCRIPTION</span></code>
 
@@ -5885,6 +5981,9 @@ <h4 id="trestle.tasks.csv_to_oscal_cd.CsvColumn" class="doc doc-heading">
     <span class="n">_columns_optional</span> <span class="o">=</span> <span class="p">[</span>
         <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">CHECK_ID</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
         <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">CHECK_DESCRIPTION</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
+        <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ORIGINAL_RISK_RATING</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
+        <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ADJUSTED_RISK_RATING</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
+        <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">RISK_ADJUSTMENT</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
     <span class="p">]</span>
 
     <span class="n">_columns_parameter</span> <span class="o">=</span> <span class="p">[</span>
@@ -5958,6 +6057,9 @@ <h4 id="trestle.tasks.csv_to_oscal_cd.CsvColumn" class="doc doc-heading">
         <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">PARAMETER_VALUE_ALTERNATIVES</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
         <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">CHECK_ID</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
         <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">CHECK_DESCRIPTION</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
+        <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ORIGINAL_RISK_RATING</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
+        <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ADJUSTED_RISK_RATING</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
+        <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">RISK_ADJUSTMENT</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
     <span class="p">]</span>
 
     <span class="nd">@staticmethod</span>
@@ -6526,7 +6628,10 @@ <h4 id="trestle.tasks.csv_to_oscal_cd.CsvToOscalComponentDefinition" class="doc
             <span class="n">text1</span> <span class="o">=</span> <span class="s1">&#39;                         &#39;</span>
         <span class="n">text1</span> <span class="o">=</span> <span class="s1">&#39;  optional columns:      &#39;</span>
         <span class="k">for</span> <span class="n">text2</span> <span class="ow">in</span> <span class="n">CsvColumn</span><span class="o">.</span><span class="n">get_optional_column_names</span><span class="p">():</span>
-            <span class="n">text2</span> <span class="o">+=</span> <span class="s1">&#39; (see note 2)&#39;</span>
+            <span class="k">if</span> <span class="n">text2</span> <span class="ow">in</span> <span class="p">[</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ORIGINAL_RISK_RATING</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ADJUSTED_RISK_RATING</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">RISK_ADJUSTMENT</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">]:</span>
+                <span class="n">text2</span> <span class="o">+=</span> <span class="s1">&#39; (see note 1)&#39;</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="n">text2</span> <span class="o">+=</span> <span class="s1">&#39; (see note 2)&#39;</span>
             <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">text1</span> <span class="o">+</span> <span class="s1">&#39;$&#39;</span> <span class="o">+</span> <span class="n">text2</span><span class="p">)</span>
             <span class="n">text1</span> <span class="o">=</span> <span class="s1">&#39;                         &#39;</span>
         <span class="k">for</span> <span class="n">text2</span> <span class="ow">in</span> <span class="n">CsvColumn</span><span class="o">.</span><span class="n">get_parameter_column_names</span><span class="p">():</span>
@@ -7586,7 +7691,10 @@ <h6 id="trestle.tasks.csv_to_oscal_cd.CsvToOscalComponentDefinition.print_info"
         <span class="n">text1</span> <span class="o">=</span> <span class="s1">&#39;                         &#39;</span>
     <span class="n">text1</span> <span class="o">=</span> <span class="s1">&#39;  optional columns:      &#39;</span>
     <span class="k">for</span> <span class="n">text2</span> <span class="ow">in</span> <span class="n">CsvColumn</span><span class="o">.</span><span class="n">get_optional_column_names</span><span class="p">():</span>
-        <span class="n">text2</span> <span class="o">+=</span> <span class="s1">&#39; (see note 2)&#39;</span>
+        <span class="k">if</span> <span class="n">text2</span> <span class="ow">in</span> <span class="p">[</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ORIGINAL_RISK_RATING</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ADJUSTED_RISK_RATING</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">RISK_ADJUSTMENT</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">]:</span>
+            <span class="n">text2</span> <span class="o">+=</span> <span class="s1">&#39; (see note 1)&#39;</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">text2</span> <span class="o">+=</span> <span class="s1">&#39; (see note 2)&#39;</span>
         <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">text1</span> <span class="o">+</span> <span class="s1">&#39;$&#39;</span> <span class="o">+</span> <span class="n">text2</span><span class="p">)</span>
         <span class="n">text1</span> <span class="o">=</span> <span class="s1">&#39;                         &#39;</span>
     <span class="k">for</span> <span class="n">text2</span> <span class="ow">in</span> <span class="n">CsvColumn</span><span class="o">.</span><span class="n">get_parameter_column_names</span><span class="p">():</span>

python_trestle_setup/index.html

@@ -4541,10 +4541,10 @@ <h1 id="install-trestle-in-a-python-virtual-environment">Install trestle in a py
 </ul>
 <h2 id="confirm-you-have-python-installed"><em>Confirm you have python installed</em><a class="headerlink" href="#confirm-you-have-python-installed" title="Permanent link">¤</a></h2>
 <ul>
-<li>Ensure you have a modern <a href="https://www.python.org/downloads/">Python</a> (3.7, 3.8, 3.9).</li>
+<li>Ensure you have a modern <a href="https://www.python.org/downloads/">Python</a> (3.9, 3.10, 3.11).</li>
 </ul>
 <div class="highlight"><pre><span></span><code>$<span class="w"> </span>python<span class="w"> </span>-V
-Python<span class="w"> </span><span class="m">3</span>.8.3
+Python<span class="w"> </span><span class="m">3</span>.9.2
 </code></pre></div>
 <h2 id="setup-a-virtual-environment"><em>Setup a virtual environment</em><a class="headerlink" href="#setup-a-virtual-environment" title="Permanent link">¤</a></h2>
 <p>There are many ways to do this on Windows, Mac and Linux and with different Python installations, so please consult