Remove locked werkzeug dependency due to CVE-2023-25577 (#174)

* Upgrade werkzeug to >=2.2.3 due to CVE-2023-25577

* 🖍️ fixing some variables / paths & adding docs

* doc: code review

Add link to issue #123 in FAQ
Fixed wrong version of werkzeug.

* chore: just remove werkzeug dependency

---------

Co-authored-by: Jeroen Van Der Donckt <[email protected]>
Co-authored-by: jonasvdd <[email protected]>
Co-authored-by: Jeroen Van Der Donckt <[email protected]>

Author: 3 people

CONTRIBUTING.md

@@ -112,7 +112,7 @@ documentation and [changelog.md](CHANGELOG.md).
 The current listing below gives you the provided steps to regenerate the documentation.
 
 1. Make sure that your python env is active (e.g., by running `poetry shell`)
-2. Navigate to `sphinx/docs` and run from that directory:
+2. Navigate to `docs/sphinx` and run from that directory:
 ```bash
 sphinx-autogen -o _autosummary && make clean html
 ```

docs/sphinx/FAQ.rst

@@ -66,6 +66,21 @@ The ``TraceUpdater`` class is a custom dash component that aids ``dcc.Graph`` co
 
 For more information on how to use the trace-updater component together with the ``FigureResampler``, see our dash app `examples <https://github.com/predict-idlab/plotly-resampler/tree/main/examples>`_` and look at the `trace-updater <https://github.com/predict-idlab/trace-updater/blob/master/trace_updater/TraceUpdater.py>`_ its documentation.
 
+.. raw:: html
+
+   </div>
+   </details>
+   <br>
+   <details>
+   <summary>
+      <a><b>My <code>FigureResampler.show_dash</code> keeps hanging (indefinitely) with the error message:<br>&nbsp;&nbsp;&nbsp; <code>OSError: Port already in use</code></b></a>
+   </summary>
+   <div style="margin-left:1em">
+
+Plotly-resampler its ``FigureResampler.show_dash`` method leverages the `jupyterdash <https://github.com/plotly/jupyter-dash>`_ toolkit to easily allow integration of dash apps in notebooks. However, there is a `known issue <https://github.com/plotly/jupyter-dash/pull/105>`_ with jupyterDash that causes the ``FigureResampler.show_dash`` method to hang when the port is already in use. In a future Pull-Request they will hopefully fix this issue. We internally track `this issue <https://github.com/predict-idlab/plotly-resampler/issues/123>` as well - please comment there if you want to provide feedback. 
+
+In the meantime, you can use the following workaround (if you do not care about the `Werkzeug security issue <https://github.com/predict-idlab/plotly-resampler/pull/174>`_): `pip install werkzeug==2.1.2`.
+
 .. raw:: html
 
    </div>
@@ -164,4 +179,4 @@ Furthermore combined with holoviews, datashader can also be employed in an inter
 
    </div>
    </details>
-   <br>
+   <br>

docs/sphinx/conf.py

@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "plotly-resampler"
-copyright = "2022, Jonas Van Der Donckt"
+copyright = "2023, Jonas Van Der Donckt"
 author = "Jonas Van Der Donckt, Jeroen Van Der Donckt, Emiel Deprost"
 
 # The full version, including alpha/beta/rc tags