Merge pull request #74 from sciris/rc1.0.0

Rc1.0.0
sciris · Dec 14, 2023 · dabf696 · dabf696
2 parents 578f23c + c6d48f4
commit dabf696
Show file tree

Hide file tree

Showing 50 changed files with 48,903 additions and 473 deletions.
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       max-parallel: 8
       matrix:
-        python-version: ['3.9']
+        python-version: ['3.11']
     name: Run tests
     steps:
       - name: Checkout sources
@@ -25,4 +25,4 @@ jobs:
         run: pip install -r requirements_test.txt
       - name: Run integration tests
         working-directory: ./tests
-        run: pytest -v test_*.py --workers auto --durations=0
+        run: pytest -v test_*.py -n auto --durations=0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,13 @@ All notable changes to this project will be documented. If you have any updates
 
 By import convention, components of the ScirisWeb library are listed beginning with `sw.`, e.g. `sw.ScirisApp()`.
 
+## Version 1.0.0 (2023-12-13)
+1. Updated to work with current versions of Python and JavaScript libraries.
+2. Added CORS option (required for serving via React).
+3. Improved exception handling.
+4. Added more examples (including React).
+5. Updated tests.
+
 ## Version 0.17.1 (2022-02-02)
 1. Fixed regression issue with Sciris.
 2. Tests switched from Travis CI to GitHub Actions.

diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,3 @@
+# Examples
+
+These examples illustrate simple ScirisWeb usage. In most cases, to use these examples, run `python app.py` in a terminal, and then go to `localhost:8080` in your browser.
diff --git a/examples/archive/gunicorn/README.md b/examples/archive/gunicorn/README.md
@@ -0,0 +1,3 @@
+# Gunicorn
+
+This shows example scripts for how to start an app using Gunicorn, and an NGINX configuration. These are useful for production-scale apps.
diff --git a/examples/gunicorn/example_launch_gunicorn → .../archive/gunicorn/example_launch_gunicorn b/examples/gunicorn/example_launch_gunicorn → .../archive/gunicorn/example_launch_gunicorn
diff --git a/examples/gunicorn/example_nginx_config → ...les/archive/gunicorn/example_nginx_config b/examples/gunicorn/example_nginx_config → ...les/archive/gunicorn/example_nginx_config
diff --git a/examples/hello-world/README.md b/examples/hello-world/README.md
@@ -0,0 +1,3 @@
+# Hello World
+
+The simplest possible ScirisWeb app.
diff --git a/examples/helloworld/app.py → examples/hello-world/app.py b/examples/helloworld/app.py → examples/hello-world/app.py
diff --git a/examples/parallel/index.html b/examples/parallel/index.html
diff --git a/examples/parallel/untitled1.py b/examples/parallel/untitled1.py
diff --git a/examples/parallel/untitled2.py b/examples/parallel/untitled2.py
diff --git a/examples/parallel/untitled3.py b/examples/parallel/untitled3.py
diff --git a/examples/plotting-react/README.md b/examples/plotting-react/README.md
@@ -0,0 +1,3 @@
+# Plotting with React
+
+A simple app illustrating plotting with a backend call, implemented in React.
diff --git a/examples/parallel/app.py → examples/plotting-react/app.py b/examples/parallel/app.py → examples/plotting-react/app.py
@@ -1,25 +1,26 @@
+'''
+Usage:
+
+python app.py
+
+then go to localhost:8080 in your browser.
+'''
+
 # Imports
 import pylab as pl
 import sciris as sc
 import scirisweb as sw
-from dask.distributed import Client
 
-
-client = Client()
-
-runserver = False # Choose to run in the frontend or backend
+runserver = True # Choose to run in the frontend or backend
 
 # Create the app
-app = sw.ScirisApp(__name__, name="ParallelComputation")
-
-#def 
+app = sw.ScirisApp(__name__, name="ReactPlot", cors=True) # CORS required for React (but not Vue)
 
-# Define the RPCs
-@app.register_RPC()
-def computation(seed=0, n=1000):
+# Define the API
+@app.route('/showgraph')
+def showgraph(n=1000):
 
     # Make graph
-    pl.seed(int(seed))
     fig = pl.figure()
     ax = fig.add_subplot(111)
     xdata = pl.randn(n)
@@ -28,11 +29,11 @@ def computation(seed=0, n=1000):
     ax.scatter(xdata, ydata, c=colors)
 
     # Convert to FE
-    graphjson = sw.mpld3ify(fig, jsonify=False)  # Convert to dict
+    graphjson = sw.mpld3ify(fig)  # Convert to dict
     return graphjson  # Return the JSON representation of the Matplotlib figure
 
 # Run the server
 if __name__ == "__main__" and runserver:
     app.run()
 else:
-    computation()
+    showgraph()
diff --git a/examples/plotting-react/index.html b/examples/plotting-react/index.html
@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+
+<!-- Load core scripts -->
+<head>
+  <title>Hello (React) World</title>
+  <script src="https://unpkg.com/react@18/umd/react.development.js"></script>
+  <script src="https://unpkg.com/react-dom@18/umd/react-dom.development.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/d3@7"></script>
+  <script src="https://mpld3.github.io/js/mpld3.v0.5.9.js"></script>
+</head>
+
+<body>
+  <div id="root"></div>
+  <script type="text/babel">
+
+// Define the functionality
+    function getdots() {
+      axios.post('http://localhost:8080/api/showgraph') // Use a POST request to pass along the value.
+      .then(function (response) {
+        document.getElementById('randomgraph').innerHTML = ''; // Clear the DOM before redrawing
+        mpld3.draw_figure('randomgraph', response.data);
+      })
+    }
+
+// Define the layout
+    function MyApp() {
+      return (
+        <>
+        <h1>Hello, React plot!</h1>
+        <div id="randomgraph"></div>
+        <button onClick={getdots}>Get new dots</button>
+        </>
+        );
+    }
+
+    const container = document.getElementById('root');
+    const root = ReactDOM.createRoot(container);
+    root.render(<MyApp />);
+
+  </script>
+</body>
+
+</html>
diff --git a/examples/plotting-vue/README.md b/examples/plotting-vue/README.md
@@ -0,0 +1,3 @@
+# Plotting with Vue
+
+A simple app illustrating plotting with a backend call, implemented in Vue.
diff --git a/examples/hellograph/app.py → examples/plotting-vue/app.py b/examples/hellograph/app.py → examples/plotting-vue/app.py
@@ -14,7 +14,7 @@
 runserver = True # Choose to run in the frontend or backend
 
 # Create the app
-app = sw.ScirisApp(__name__, name="HelloGraph")
+app = sw.ScirisApp(__name__, name="VuePlot")
 
 # Define the API
 @app.route('/showgraph')
@@ -36,4 +36,4 @@ def showgraph(n=1000):
 if __name__ == "__main__" and runserver:
     app.run()
 else:
-    showgraph()
+    showgraph()
diff --git a/examples/plotting-vue/assets/README.md b/examples/plotting-vue/assets/README.md
@@ -0,0 +1,3 @@
+# Assets
+
+This folder is not used, but uses frozen versions of key libraries to help with debugging.
diff --git a/examples/plotting-vue/assets/d3.v5.min.js b/examples/plotting-vue/assets/d3.v5.min.js
diff --git a/examples/plotting-vue/assets/mpld3.v0.4.1.min.js b/examples/plotting-vue/assets/mpld3.v0.4.1.min.js
diff --git a/examples/plotting-vue/assets/polyfill.min.js b/examples/plotting-vue/assets/polyfill.min.js