release v0.5.3.0

IBM · Dec 30, 2021 · 7143286 · 7143286
1 parent da84f31
commit 7143286
Show file tree

Hide file tree

Showing 25 changed files with 669 additions and 401 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]## [0.5.3.0b]
+## [0.5.3.0] - 2021-12-30
 ### Changed
 - ScenarioDbManager - refactoring, cleanup and documentation
 ### Added

diff --git a/VersioningReadMe.md b/VersioningReadMe.md
@@ -17,27 +17,28 @@ Note that if you added/removed modules, you first need to re-run the sphinx comm
 3. For PyPI, build the wheel file.
 a. Delete all files in `./dist`
 b. Open Terminal, from root, run <br>
-`python setup.py sdist bdist_wheel`
+`cd ..
+4. `
 
-4. Upload to PyPI (from PyCharm terminal run):<br>
+5. Upload to PyPI (from PyCharm terminal run):<br>
 `twine upload dist/*  --verbose`
 Enter username and password when prompted.
 (For TestPyPI use: `twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose`)<br>
 Before the twine upload, you can check the distribution with:<br>
 `twine check dist/*`
 
-5. For JFrog, run `setup.py` with the following arguments:<br>
+6. For JFrog, run `setup.py` with the following arguments:<br>
 `python setup.py sdist bdist_wheel upload -r local`<br>
 (This is in the saved PyCharm run configuration `setup_egg_wheel_artifactory`)
 
-6. From GitGui, commit into beta branch and push into git repo.
+7. From GitGui, commit into beta branch and push into git repo.
 Then either:
     1. In GitHub do a pull-request from the beta into the master, or
     2. In GitGui, switch to master and merge from beta branch. Then push into GitHub. (In case we need to resolve conflicts.)
 
-7. In GitHub, create a new release with a tag like v0.2.0
+8. In GitHub, create a new release with a tag like v0.2.0
 
-8. In GitGui, make a new branch `v0.2.1b`
+9. In GitGui, make a new branch `v0.2.1b`
 
-9. Change the versions in `dse_do_utils.version.py` to the next beta version, e.g. `0.2.1b`
+10. Change the versions in `dse_do_utils.version.py` to the next beta version, e.g. `0.2.1b`
 
diff --git a/docs/doc_build/doctrees/dse_do_utils.doctree b/docs/doc_build/doctrees/dse_do_utils.doctree
diff --git a/docs/doc_build/doctrees/environment.pickle b/docs/doc_build/doctrees/environment.pickle
diff --git a/docs/doc_build/html/.buildinfo b/docs/doc_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 2c638b537d47ae366d7130796eb498ee
+config: 817acda8ad4a4dba21b1d70b0d0f1a83
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/doc_build/html/_modules/dse_do_utils/datamanager.html b/docs/doc_build/html/_modules/dse_do_utils/datamanager.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dse_do_utils.datamanager &#8212; DSE DO Utils 0.5.2.0 documentation</title>
+    <title>dse_do_utils.datamanager &#8212; DSE DO Utils 0.5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.3.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../dse_do_utils.html" accesskey="U">dse_do_utils</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dse_do_utils.datamanager</a></li> 
@@ -437,7 +437,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.3.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../dse_do_utils.html" >dse_do_utils</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dse_do_utils.datamanager</a></li> 

diff --git a/docs/doc_build/html/_modules/dse_do_utils/optimizationengine.html b/docs/doc_build/html/_modules/dse_do_utils/optimizationengine.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dse_do_utils.optimizationengine &#8212; DSE DO Utils 0.5.2.0 documentation</title>
+    <title>dse_do_utils.optimizationengine &#8212; DSE DO Utils 0.5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.3.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../dse_do_utils.html" accesskey="U">dse_do_utils</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dse_do_utils.optimizationengine</a></li> 
@@ -350,7 +350,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.3.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../dse_do_utils.html" >dse_do_utils</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dse_do_utils.optimizationengine</a></li> 

diff --git a/docs/doc_build/html/_modules/dse_do_utils/plotlymanager.html b/docs/doc_build/html/_modules/dse_do_utils/plotlymanager.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dse_do_utils.plotlymanager &#8212; DSE DO Utils 0.5.2.0 documentation</title>
+    <title>dse_do_utils.plotlymanager &#8212; DSE DO Utils 0.5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.3.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../dse_do_utils.html" accesskey="U">dse_do_utils</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dse_do_utils.plotlymanager</a></li> 
@@ -44,23 +44,26 @@ <h3>Navigation</h3>
           <div class="body" role="main">
 
   <h1>Source code for dse_do_utils.plotlymanager</h1><div class="highlight"><pre>
-<span></span><span class="c1"># from typing import List, Dict, Tuple, Optional</span>
+<span></span><span class="c1"># Copyright IBM All Rights Reserved.</span>
+<span class="c1"># SPDX-License-Identifier: Apache-2.0</span>
+
+<span class="c1"># from typing import List, Dict, Tuple, Optional</span>
 <span class="kn">from</span> <span class="nn">dse_do_utils.datamanager</span> <span class="kn">import</span> <span class="n">DataManager</span>
 
-<span class="kn">from</span> <span class="nn">IPython.display</span> <span class="kn">import</span> <span class="n">display</span><span class="p">,</span> <span class="n">HTML</span>
-<span class="kn">import</span> <span class="nn">plotly</span>
-<span class="kn">import</span> <span class="nn">plotly.graph_objs</span> <span class="k">as</span> <span class="nn">go</span>
+<span class="c1"># import plotly</span>
+<span class="c1"># import plotly.graph_objs as go</span>
 
-<span class="k">def</span> <span class="nf">_show</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-    <span class="sd">&quot;&quot;&quot;Work-around for showing a Plotly go.Figure in JupyterLab in CPD 3.5</span>
-<span class="sd">    Usage:</span>
-<span class="sd">        1. `import plotlymanager`. This will run this code and add the custom method `_show()` to `go.Figure`</span>
-<span class="sd">        2. Create a go.Figure fig in the normal Plotly way. Then in the last line of the cell, instead of `fig.show()`, do a:</span>
-<span class="sd">        3. `fig._show()`</span>
-<span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">html</span> <span class="o">=</span> <span class="n">plotly</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">to_html</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
-    <span class="n">display</span><span class="p">(</span><span class="n">HTML</span><span class="p">(</span><span class="n">html</span><span class="p">))</span>
-<span class="n">go</span><span class="o">.</span><span class="n">Figure</span><span class="o">.</span><span class="n">_show</span> <span class="o">=</span> <span class="n">_show</span>
+<span class="c1"># def _show(self):</span>
+<span class="c1">#     &quot;&quot;&quot;Work-around for showing a Plotly go.Figure in JupyterLab in CPD 3.5</span>
+<span class="c1">#     Usage:</span>
+<span class="c1">#         1. `import plotlymanager`. This will run this code and add the custom method `_show()` to `go.Figure`</span>
+<span class="c1">#         2. Create a go.Figure fig in the normal Plotly way. Then in the last line of the cell, instead of `fig.show()`, do a:</span>
+<span class="c1">#         3. `fig._show()`</span>
+<span class="c1">#     &quot;&quot;&quot;</span>
+<span class="c1">#     from IPython.display import display, HTML  # Need to import dynamically. Otherwise problems running locally in pure Python (i.e. without Jupyter)</span>
+<span class="c1">#     html = plotly.io.to_html(self)</span>
+<span class="c1">#     display(HTML(html))</span>
+<span class="c1"># go.Figure._show = _show</span>
 
 
 <div class="viewcode-block" id="PlotlyManager"><a class="viewcode-back" href="../../dse_do_utils.html#dse_do_utils.plotlymanager.PlotlyManager">[docs]</a><span class="k">class</span> <span class="nc">PlotlyManager</span><span class="p">():</span>
@@ -71,14 +74,16 @@ <h1>Source code for dse_do_utils.plotlymanager</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">dm</span> <span class="o">=</span> <span class="n">dm</span>
 
 <div class="viewcode-block" id="PlotlyManager.get_plotly_fig_m"><a class="viewcode-back" href="../../dse_do_utils.html#dse_do_utils.plotlymanager.PlotlyManager.get_plotly_fig_m">[docs]</a>    <span class="k">def</span> <span class="nf">get_plotly_fig_m</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
-        <span class="sd">&quot;&quot;&quot;On the instance `self`, call the method named by id[&#39;index&#39;]</span>
+        <span class="sd">&quot;&quot;&quot;DEPRECATED. Not used in dse_do_dashboard package.</span>
+<span class="sd">        On the instance `self`, call the method named by id[&#39;index&#39;]</span>
 <span class="sd">        For use with pattern-matching callbacks. Assumes the id[&#39;index&#39;] is the name of a method of this class and returns a fig.</span>
 <span class="sd">        Used in dse_do_dashboard Plotly-Dash dashboards</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">[</span><span class="s1">&#39;index&#39;</span><span class="p">])()</span></div>
 
 <div class="viewcode-block" id="PlotlyManager.get_dash_tab_layout_m"><a class="viewcode-back" href="../../dse_do_utils.html#dse_do_utils.plotlymanager.PlotlyManager.get_dash_tab_layout_m">[docs]</a>    <span class="k">def</span> <span class="nf">get_dash_tab_layout_m</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">page_id</span><span class="p">):</span>
-        <span class="sd">&quot;&quot;&quot;On the instance `self`, call the method named by get_tab_layout_{page_id}.</span>
+        <span class="sd">&quot;&quot;&quot;DEPRECATED. Not used in dse_do_dashboard package.</span>
+<span class="sd">        On the instance `self`, call the method named by get_tab_layout_{page_id}.</span>
 <span class="sd">        Used in dse_do_dashboard Plotly-Dash dashboards</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;get_tab_layout_</span><span class="si">{</span><span class="n">page_id</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)()</span></div></div>
@@ -113,7 +118,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.3.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../dse_do_utils.html" >dse_do_utils</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dse_do_utils.plotlymanager</a></li>