Update from upstream 1.1.2dev

.gitignore

@@ -15,3 +15,16 @@ build/
 # python virtual env
 env/
 venv/
+.cache/
+data8assets/
+.autopull_list
+summer/
+test-repo/
+
+.ipynb_checkpoints
+docs/_build
+
+node_modules/
+package-lock.json
+
+nbgitpuller/static/dist

MANIFEST.in

@@ -1,5 +1,6 @@
 include *.md
 include LICENSE
+include package.json
 include setup.cfg
 recursive-include nbfetch/static *
 recursive-include nbfetch/templates *

README.md

@@ -4,8 +4,11 @@ Fork of nbgitpuller allowing access to Hydroshare resources.
 
 -------------------
 
-One-way synchronization of a remote git repository to a local git repository,
-with automatic conflict resolution.
+`nbgitpuller` lets you distribute content in a git repository to your students
+by having them click a simple link. [Automatic
+merging](https://nbgitpuller.readthedocs.io/topic/automatic-merging.html)
+ensures that your students are never exposed to `git` directly. It is primarily
+used with a JupyterHub, but can also work on students' local computers.
 
 Pull Hydroshare resources to a local directory.
 

nbfetch/__init__.py

@@ -79,6 +79,67 @@ def initialize_handlers(self):
             ]
         )
 
-
-def _jupyter_server_extension_paths():
-    return [{"module": "nbfetch", "app": NbFetchApp}]
+def _jupyter_server_extension_points():
+    """
+    This function is detected by `notebook` and `jupyter_server` because they
+    are explicitly configured to inspect the nbgitpuller module for it. That
+    explicit configuration is passed via setup.py's declared data_files.
+
+    Returns a list of dictionaries with metadata describing where to find the
+    `_load_jupyter_server_extension` function.
+    """
+    return [{
+        "module": "nbfetch", "app": NbFetchApp,
+    }]
+
+
+def _load_jupyter_server_extension(app):
+    """
+    This function is a hook for `notebook` and `jupyter_server` that we use to
+    register additional endpoints to be handled by nbfetch.
+
+    Note that as this function is used as a hook for both notebook and
+    jupyter_server, the argument passed may be a NotebookApp or a ServerApp.
+
+    Related documentation:
+    - notebook: https://jupyter-notebook.readthedocs.io/en/stable/extending/handlers.htmland
+    - notebook: https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Distributing%20Jupyter%20Extensions%20as%20Python%20Packages.html#Example---Server-extension
+    - jupyter_server: https://jupyter-server.readthedocs.io/en/latest/developers/extensions.html
+    """
+    web_app = app.web_app
+    base_url = url_path_join(web_app.settings['base_url'], 'nbfetch')
+    handlers = [
+        (url_path_join(base_url, 'api'), SyncHandler),
+        (base_url, UIHandler),
+        (url_path_join(web_app.settings['base_url'], 'git-sync'), LegacyGitSyncRedirectHandler),
+        (url_path_join(web_app.settings['base_url'], 'interact'), LegacyInteractRedirectHandler),
+        (
+            url_path_join(base_url, 'static', '(.*)'),
+            StaticFileHandler,
+            {'path': os.path.join(os.path.dirname(__file__), 'static')}
+        )
+    ]
+    # FIXME: See note on how to stop relying on settings to pass information:
+    #        https://github.com/jupyterhub/nbgitpuller/pull/242#pullrequestreview-854968180
+    #
+    web_app.settings['nbapp'] = app
+    web_app.add_handlers('.*', handlers)
+
+
+# For compatibility with both notebook and jupyter_server, we define
+# _jupyter_server_extension_paths alongside _jupyter_server_extension_points.
+#
+# "..._paths" is used by notebook and still supported by jupyter_server as of
+# jupyter_server 1.13.3, but was renamed to "..._points" in jupyter_server
+# 1.0.0.
+#
+_jupyter_server_extension_paths = _jupyter_server_extension_points
+
+# For compatibility with both notebook and jupyter_server, we define both
+# load_jupyter_server_extension alongside _load_jupyter_server_extension.
+#
+# "load..." is used by notebook and "_load..." is used by jupyter_server.
+#
+
+# TODO: DRC 06.06.23 hope we can get away without this...
+# load_jupyter_server_extension = _load_jupyter_server_extension