Merge pull request #245 from minrk/yaml-dep

express yaml optional dependency
jupyterhub · May 29, 2024 · fa5f6fa · fa5f6fa
2 parents b2f8e59 + 8eb6ca1
commit fa5f6fa
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/source/file.md b/docs/source/file.md
@@ -75,6 +75,15 @@ will be managed by JupyterHub. This allows e.g., the administrator to configure
 
 ```
 
+````{note}
+yaml support requires the `ruamel.yaml` package, which you can install directly, or with:
+
+```
+pip install jupyterhub-traefik-proxy[yaml]
+```
+
+````
+
 ## Externally managed TraefikFileProviderProxy
 
 When TraefikFileProviderProxy is externally managed, service managers like [systemd](https://www.freedesktop.org/wiki/Software/systemd/)

diff --git a/setup.py b/setup.py
@@ -20,8 +20,9 @@
         # see https://github.com/jupyterhub/traefik-proxy/issues/155 for more
         "consul": ["python-consul2"],
         "etcd": ["etcdpy"],
+        "yaml": ["ruamel.yaml"],
         "test": [
-            "jupyterhub-traefik-proxy[redis,etcd,consul]",
+            "jupyterhub-traefik-proxy[redis,etcd,consul,yaml]",
             "certipy",
             "notebook>=4.0",
             "pytest",