Merge branch 'master' into example

Author: echarles

.github/workflows/main.yml

@@ -24,10 +24,6 @@ jobs:
     - name: Install the Python dependencies
       run: |
         pip install -e .[test]
-    - name: ipykernel fix on windows 3.8
-      if: matrix.os == 'windows-latest' && matrix.python-version == '3.8'
-      run: |
-        pip install --upgrade git+https://github.com/ipython/ipykernel.git
     - name: Run the tests
       run: |
         pytest

.gitignore

@@ -33,6 +33,7 @@ src
 *.swp
 *.map
 .idea/
+.vscode/
 Read the Docs
 config.rst
 

CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2020-1-10
+
+### Added
+
+- **pytest-plugin** for Jupyter Server.
+    - Allows one to write async/await syntax in tests functions.
+    - Some particularly useful fixtures include:
+        - `serverapp`: a default ServerApp instance that handles setup+teardown.
+        - `configurable_serverapp`: a function that returns a ServerApp instance.
+        - `fetch`: an awaitable function that tests makes requests to the server API
+        - `create_notebook`: a function that writes a notebook to a given temporary file path.
 
 ## [0.2.0] - 2019-12-19
 

README.md

@@ -21,11 +21,23 @@ You can find the installation documentation for the
 The documentation for advanced usage of Jupyter notebook can be found
 [here](https://jupyter-server.readthedocs.io/en/latest/).
 
-For a local installation, make sure you have
+To install the latest release locally, make sure you have
 [pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
 
     $ pip install jupyter_server
 
+### Versioning and Branches
+
+If Jupyter Server is a dependency of your project/application, it is important that you pin it to a version that works for your application. Currently, Jupyter Server only has minor and patch versions. Different minor versions likely include API-changes while patch versions do not change API.
+
+When a new minor version in released on PyPI, a branch for that version will be created in this repository, and the version of the master branch will be bumped to the next minor version number. That way, the master branch always reflects the latest un-released version.
+
+To see the changes between releases, checkout the [CHANGELOG](https://github.com/jupyter/jupyter_server/blob/master/CHANGELOG.md).
+
+To install the latest patch of a given version:
+
+    $ pip install jupyter_server>=0.2
+
 ## Usage - Running Jupyter Server
 
 ### Running in a local installation

appveyor.yml

@@ -21,7 +21,7 @@ environment:
 platform:
   - x64
 
-build: off
+build: false
 
 install:
   - cmd: call %CONDA_INSTALL_LOCN%\Scripts\activate.bat
@@ -31,11 +31,9 @@ install:
   - cmd: conda config --add channels conda-forge
   - cmd: conda update --yes --quiet conda
   - cmd: conda info -a
-  - cmd: conda create -y -q -n test-env-%CONDA_PY% python=%CONDA_PY_SPEC% pyzmq tornado jupyter_client nbformat nbconvert ipykernel pip nose
+  - cmd: conda create -y -q -n test-env-%CONDA_PY% python=%CONDA_PY_SPEC% pip pyzmq tornado jupyter_client nbformat nbconvert nose
   - cmd: conda activate test-env-%CONDA_PY%
-  - cmd: pip install .[test]
-# FIXME: Use patch for python 3.8, windows issues (https://github.com/ipython/ipykernel/pull/456) - remove once released
-  - IF %CONDA_PY% == 38 pip install --upgrade git+https://github.com/ipython/ipykernel.git
+  - cmd: pip install -e .[test]
 
 test_script:
-  - pytest
+  - pytest -s -v

docs/source/frontends.rst

@@ -14,7 +14,7 @@ Writing a frontend application
 Jupyter Server provides two key classes for writing a server frontend: 
 
     - ``ExtensionApp``
-    - ``ExtensionHandler``
+    - ``ExtensionHandlerMixin``
 
 The ExtensionApp:
 
@@ -81,13 +81,13 @@ Properties
 Writing frontend handlers
 -------------------------
 
-To write handlers for an ``ExtensionApp``, use the ``ExtensionHandler`` class. This class routes Tornado's ``static_url`` attribute to the ``/static/<extension_name>/`` namespace where your frontend's static files will be served.
+To write handlers for an ``ExtensionApp``, use the ``ExtensionHandlerMixin`` class. This class routes Tornado's ``static_url`` attribute to the ``/static/<extension_name>/`` namespace where your frontend's static files will be served.
 
 .. code-block:: python
 
-    from jupyter_server.extension import ExtensionHandler
+    from jupyter_server.extension import ExtensionHandlerMixin
 
-    class MyFrontendHandler(ExtensionHandler):
+    class MyFrontendHandler(ExtensionHandlerMixin, JupyterHandler):
 
         urls = ['/myfrontend/hello']
 
@@ -97,7 +97,7 @@ To write handlers for an ``ExtensionApp``, use the ``ExtensionHandler`` class. T
         def post(self):
             ...
 
-ExtensionHandler comes with the following properties:
+ExtensionHandlerMixin comes with the following properties:
 
 * ``config``: the ExtensionApp's config object.
 * ``server_config``: the ServerApp's config object.

jupyter_server/_version.py

@@ -9,5 +9,5 @@
 
 # Next beta/alpha/rc release: The version number for beta is X.Y.ZbN **without dots**.
 
-version_info = (0, 2, 0, '.dev0')
+version_info = (0, 3, 0, '.dev')
 __version__ = '.'.join(map(str, version_info[:3])) + ''.join(version_info[3:])

jupyter_server/extension/application.py

@@ -18,7 +18,7 @@
 from jupyter_server.serverapp import ServerApp, aliases, flags
 from jupyter_server.transutils import _
 from jupyter_server.utils import url_path_join
-from .handler import ExtensionHandler
+from .handler import ExtensionHandlerMixin
 
 # Remove alias for nested classes in ServerApp.
 # Nested classes are not allowed in ExtensionApp.
@@ -154,6 +154,7 @@ class method. This method can be set as a entry_point in
         help="Name of extension."
     )
 
+    @default('extension_name')
     def _extension_name_default(self):
         try:
             return self.name
@@ -163,8 +164,8 @@ def _extension_name_default(self):
     INVALID_EXTENSION_NAME_CHARS = [' ', '.', '+', '/']
 
     @validate('extension_name')
-    def _validate_extension_name(self, value):
-        #value = self.extension_name
+    def _validate_extension_name(self, proposal):
+        value = proposal['value']
         if isinstance(value, str):
             # Validate that extension_name doesn't contain any invalid characters.
             for c in ExtensionApp.INVALID_EXTENSION_NAME_CHARS:
@@ -320,7 +321,7 @@ def _prepare_handlers(self):
 
             # Get handler kwargs, if given
             kwargs = {}
-            if issubclass(handler, ExtensionHandler):
+            if issubclass(handler, ExtensionHandlerMixin):
                 kwargs['extension_name'] = self.extension_name
             try: 
                 kwargs.update(handler_items[2])
@@ -351,6 +352,7 @@ def _prepare_templates(self):
             self.settings.update({
                 "{}_template_paths".format(self.extension_name): self.template_paths
             })
+        self.initialize_templates()
 
     @staticmethod
     def initialize_server(argv=[], load_other_extensions=True, **kwargs):

jupyter_server/extension/handler.py

@@ -1,4 +1,4 @@
-from jupyter_server.base.handlers import JupyterHandler, FileFindHandler
+from jupyter_server.base.handlers import FileFindHandler
 from traitlets import Unicode, default
 
 
@@ -12,7 +12,7 @@ def get_template(self, name):
         return self.settings[env].get_template(name)
 
 
-class ExtensionHandler(JupyterHandler):
+class ExtensionHandlerMixin():
     """Base class for Jupyter server extension handlers. 
 
     Subclasses can serve static files behind a namespaced 

jupyter_server/prometheus/metrics.py

@@ -1,5 +1,5 @@
 """
-Prometheus metrics exported by Jupyter Notebook Server
+Prometheus metrics exported by Jupyter Server
 
 Read https://prometheus.io/docs/practices/naming/ for naming
 conventions for metrics & labels.