#144 Sandbox and Goal concepts added (#145)

* #144 Fix URL * #144 Savepoint * #144 Savepoint * #144 Savepoint * #144 Savepoint * #144 Update dependencies
senzing-garage · Nov 20, 2024 · eca0c39 · eca0c39
1 parent 99e9291
commit eca0c39
Show file tree

Hide file tree

Showing 26 changed files with 726 additions and 173 deletions.
diff --git a/.gitignore b/.gitignore
@@ -48,3 +48,5 @@ coverage.out
 .settings
 /.mypy_cache/
 /.pytest_cache/
+
+.ipynb_checkpoints
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.4.2] - 2024-11-20
+
+### Changed in 0.4.2
+
+- Add "Sandbox" concept
+- Add goals
+
 ## [0.4.0] - 2024-11-19
 
 ### Changed in 0.4.0

diff --git a/go.mod b/go.mod
@@ -39,7 +39,7 @@ require (
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-sql-driver/mysql v1.8.1 // indirect
-	github.com/godror/godror v0.45.1 // indirect
+	github.com/godror/godror v0.45.2 // indirect
 	github.com/godror/knownpb v0.2.0 // indirect
 	github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9 // indirect
 	github.com/golang-sql/sqlexp v0.1.0 // indirect

diff --git a/go.sum b/go.sum
@@ -58,8 +58,8 @@ github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
 github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
 github.com/go-sql-driver/mysql v1.8.1 h1:LedoTUt/eveggdHS9qUFC1EFSa8bU2+1pZjSRpvNJ1Y=
 github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg=
-github.com/godror/godror v0.45.1 h1:MnnUcU9/9rpLV3/Amv6kiT82pAlR0v5MFk/EXdKrblU=
-github.com/godror/godror v0.45.1/go.mod h1:44hxVDzvFSwc+yGyRM+riCLNAY5SwZkUfLzVTh5MXCg=
+github.com/godror/godror v0.45.2 h1:rkXxmD+/QdKz0PTOuSfEmWNFCHnKpWS8b8HUl+5V7us=
+github.com/godror/godror v0.45.2/go.mod h1:44hxVDzvFSwc+yGyRM+riCLNAY5SwZkUfLzVTh5MXCg=
 github.com/godror/knownpb v0.2.0 h1:RJLntksFiKUHoUz3wCCJ8+DBjxSLYHYDNl1xRz0/gXI=
 github.com/godror/knownpb v0.2.0/go.mod h1:kRahRJBwqTenpVPleymQ4k433Xz2Wuy7dOeFSuEpmkI=
 github.com/golang-jwt/jwt/v5 v5.2.0 h1:d/ix8ftRUorsN+5eMIlF4T6J8CAt9rch3My2winC1Jw=

diff --git a/httpserver/static/root/component/bottom-nav.html b/httpserver/static/root/component/bottom-nav.html
@@ -11,7 +11,16 @@
                         External sites
                     </a>
                     <ul class="dropdown-menu">
-                        <li><a class="dropdown-item" href="https://senzing.com/docs/">Documentation</a></li>
+                        <li><a class="dropdown-item" href="https://senzing.com/docs/">Senzing Documentation</a></li>
+                        <hr />
+                        <li><a class="dropdown-item"
+                                href="https://senzing-garage.github.io/sz-sdk-python-abstract/">Senzing Python SDK
+                                Documentation</a></li>
+                        <li><a class="dropdown-item" href="#">Senzing Java SDK Documentation</a></li>
+                        <li><a class="dropdown-item"
+                                href="https://pkg.go.dev/github.com/senzing-garage/sz-sdk-go-grpc">Senzing Go SDK
+                                Documentation</a></li>
+                        <li><a class="dropdown-item" href="#">Senzing C# SDK Documentation</a></li>
                     </ul>
                 </li>
             </ul>

diff --git a/httpserver/static/root/component/install-python-package.html b/httpserver/static/root/component/install-python-package.html
@@ -0,0 +1,10 @@
+<p>
+    Prepare your Python environment by installing the <a href="https://pypi.org/project/senzing-grpc/">senzing-grpc</a>
+    package into your environment.
+    <br>Example:
+<div class="mb-6 bg-light">
+    <pre><code>
+    python3 -m pip install --upgrade senzing-grpc
+    </code></pre>
+</div>
+</p>
diff --git a/httpserver/static/root/component/left-nav-python.html b/httpserver/static/root/component/left-nav-python.html
@@ -1,10 +1,10 @@
 <a href="/" class="d-flex align-items-center mb-3 mb-md-0 me-md-auto text-white text-decoration-none">
-  <span class="fs-3">Senzing Playground</span>
+  <span class="fs-3">Senzing</span>
 </a>
 <hr>
 <ul class="nav nav-pills flex-column mb-auto">
   <li class="nav-item">
-    <a href="/site/overview.html" class="nav-link  text-white" aria-current="page">
+    <a href="/site/home.html" class="nav-link text-white" aria-current="page">
       <i class="bi bi-house me-2"></i>
       <strong>Home</strong>
     </a>
@@ -16,43 +16,43 @@
     </a>
   </li>
   <li>
-    <a href="/site/python.html" class="nav-link active">
+    <a href="/site/python/index.html" class="nav-link active">
       &nbsp; &nbsp;
-      <img src="../images/python-svgrepo-com.svg" alt="Python" width="32" height="32">
+      <img src="/images/python-svgrepo-com.svg" alt="Python" width="32" height="32">
       &nbsp; Python </a>
   </li>
   <li>
-    <a href="/site/java.html" class="nav-link text-white">
+    <a href="/site/java/index.html" class="nav-link text-white">
       &nbsp; &nbsp;
-      <img src="../images/java-icon.svg" alt="Go" width="24" height="24">
+      <img src="/images/java-icon.svg" alt="Go" width="24" height="24">
       &nbsp; &nbsp; Java
     </a>
   </li>
   <li>
-    <a href="/site/go.html" class="nav-link text-white">
+    <a href="/site/go/index.html" class="nav-link text-white">
       &nbsp; &nbsp;
-      <img src="../images/Go-Logo_White.svg" alt="Go" width="32" height="32">
+      <img src="/images/Go-Logo_White.svg" alt="Go" width="32" height="32">
       &nbsp;Go
     </a>
   </li>
   <li>
-    <a href="/site/csharp.html" class="nav-link text-white">
+    <a href="/site/csharp/index.html" class="nav-link text-white">
       &nbsp; &nbsp;
-      <img src="../images/32px-Logo_C_sharp.svg.png" alt="C-sharp" width="24" height="24">
+      <img src="/images/32px-Logo_C_sharp.svg.png" alt="C-sharp" width="24" height="24">
       &nbsp; &nbsp; C#
     </a>
   </li>
   <li class="nav-item">
-    <a href="/site/tools.html" class="nav-link text-white" aria-current="page">
+    <a href="/site/tools/index.html" class="nav-link text-white" aria-current="page">
       <i class="bi bi-tools me-2"></i>
       <strong>Tools</strong>
     </a>
   </li>
 </ul>
 
 <div class="dropdown">
-  <a href="#" class="d-flex align-items-center text-white text-decoration-none dropdown-toggle"
-    data-bs-toggle="dropdown" aria-expanded="false">
+  <a href="#" class="d-flex align-items-center text-dark text-decoration-none dropdown-toggle" data-bs-toggle="dropdown"
+    aria-expanded="false">
   </a>
   <ul class="dropdown-menu dropdown-menu-dark text-small shadow">
     <li><a class="dropdown-item" href="/site/debug.html">Debug</a></li>

diff --git a/httpserver/static/root/component/left-nav.html b/httpserver/static/root/component/left-nav.html
@@ -1,10 +1,10 @@
 <a href="/" class="d-flex align-items-center mb-3 mb-md-0 me-md-auto text-white text-decoration-none">
-  <span class="fs-3">Senzing Playground</span>
+  <span class="fs-3">Senzing</span>
 </a>
 <hr>
 <ul class="nav nav-pills flex-column mb-auto">
   <li class="nav-item">
-    <a href="/site/overview.html" class="nav-link active" aria-current="page">
+    <a href="/site/home.html" class="nav-link active" aria-current="page">
       <i class="bi bi-house me-2"></i>
       <strong>Home</strong>
     </a>
@@ -16,43 +16,43 @@
     </a>
   </li>
   <li>
-    <a href="/site/python.html" class="nav-link text-white">
+    <a href="/site/python/index.html" class="nav-link text-white">
       &nbsp; &nbsp;
-      <img src="../images/python-svgrepo-com.svg" alt="Python" width="32" height="32">
+      <img src="/images/python-svgrepo-com.svg" alt="Python" width="32" height="32">
       &nbsp; Python </a>
   </li>
   <li>
-    <a id="bob-java" href="/site/java.html" class="nav-link text-white">
+    <a id="bob-java" href="/site/java/index.html" class="nav-link text-white">
       &nbsp; &nbsp;
-      <img src="../images/java-icon.svg" alt="Go" width="24" height="24">
+      <img src="/images/java-icon.svg" alt="Go" width="24" height="24">
       &nbsp; &nbsp; Java
     </a>
   </li>
   <li>
-    <a href="/site/go.html" class="nav-link text-white">
+    <a href="/site/go/index.html" class="nav-link text-white">
       &nbsp; &nbsp;
-      <img src="../images/Go-Logo_White.svg" alt="Go" width="32" height="32">
+      <img src="/images/Go-Logo_White.svg" alt="Go" width="32" height="32">
       &nbsp;Go
     </a>
   </li>
   <li>
-    <a href="/site/csharp.html" class="nav-link text-white">
+    <a href="/site/csharp/index.html" class="nav-link text-white">
       &nbsp; &nbsp;
-      <img src="../images/32px-Logo_C_sharp.svg.png" alt="C-sharp" width="24" height="24">
+      <img src="/images/32px-Logo_C_sharp.svg.png" alt="C-sharp" width="24" height="24">
       &nbsp; &nbsp; C#
     </a>
   </li>
   <li class="nav-item">
-    <a href="/site/tools.html" class="nav-link text-white" aria-current="page">
+    <a href="/site/tools/index.html" class="nav-link text-white" aria-current="page">
       <i class="bi bi-tools me-2"></i>
       <strong>Tools</strong>
     </a>
   </li>
 </ul>
 
 <div class="dropdown">
-  <a href="#" class="d-flex align-items-center text-white text-decoration-none dropdown-toggle"
-    data-bs-toggle="dropdown" aria-expanded="false">
+  <a href="#" class="d-flex align-items-center text-dark text-decoration-none dropdown-toggle" data-bs-toggle="dropdown"
+    aria-expanded="false">
   </a>
   <ul class="dropdown-menu dropdown-menu-dark text-small shadow">
     <li><a class="dropdown-item" href="/site/debug.html">Debug</a></li>

diff --git a/httpserver/static/root/component/sdk-doc-python.html b/httpserver/static/root/component/sdk-doc-python.html
@@ -0,0 +1,4 @@
+<p>
+    The Senzing SDK for Python methods are documented in the <i class="bi bi-box-arrow-up-right me-1"></i>
+    <a href="https://senzing-garage.github.io/sz-sdk-python-abstract/">Senzing Software Development Kit (SDK)</a>.
+</p>
diff --git a/httpserver/static/root/component/serve-grpc.html b/httpserver/static/root/component/serve-grpc.html
@@ -0,0 +1,8 @@
+<p>
+    In the future, if you only need a gRPC server (Sandbox), but not the Senzing Playground, run:
+</p>
+<div class="mb-6 bg-light">
+    <pre><code>
+    docker run -it --name senzing-serve-grpc -p 8261:8261 --pull always --rm senzing/serve-grpc
+    </code></pre>
+</div>
diff --git a/httpserver/static/root/css/site.css b/httpserver/static/root/css/site.css
diff --git a/httpserver/static/root/index.html b/httpserver/static/root/index.html
@@ -2,7 +2,7 @@
 <html>
 
 <head>
-    <meta http-equiv="refresh" content="0; url=site/overview.html">
+    <meta http-equiv="refresh" content="0; url=site/home.html">
 </head>
 
 </html>
diff --git a/httpserver/static/templates/site/csharp.html → ...r/static/templates/site/csharp/index.html b/httpserver/static/templates/site/csharp.html → ...r/static/templates/site/csharp/index.html
diff --git a/httpserver/static/templates/site/extras.html b/httpserver/static/templates/site/extras.html
@@ -101,7 +101,7 @@ <h3>Services</h3>
   </table>
 
   <p>
-    <a href="overview.html">Overview</a>
+    <a href="/site/home.html">Overview</a>
   </p>
 
 </body>

diff --git a/httpserver/static/templates/site/java.html → ...erver/static/templates/site/go/index.html b/httpserver/static/templates/site/java.html → ...erver/static/templates/site/go/index.html
@@ -10,7 +10,7 @@
     <script src="/js/bootstrap.bundle.min.js" type="text/javascript"></script>
     <script src="/js/jquery.dataTables.min.js" type="text/javascript"></script>
     <script src="/js/include-html.js" type="text/javascript"></script>
-    <title>Senzing Playground - Java</title>
+    <title>Senzing Playground - Go</title>
 </head>
 
 <body>
@@ -20,8 +20,8 @@
         </div>
         <div class="container">
             <div class="col-xs-12" style="height:15px;"></div>
-            <h1>Senzing Playground for Java</h1>
-            <p>Java is not ready yet.</p>
+            <h1>Senzing Playground for Go</h1>
+            <p>Go is not ready yet.</p>
             <div class="col-xs-12" style="height:350px;"></div>
             <div id="bottom-nav" w3-include-html="/component/bottom-nav.html" />
         </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     <html>
     <head>
-        <meta http-equiv="refresh" content="0; url=site/overview.html">
+        <meta http-equiv="refresh" content="0; url=site/home.html">
     </head>
     </html>