Merge branch 'master' into remove-travis

Author: echarles

.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: CI
+name: Jupyter Server Tests
 on:
   push:
     branches: 
@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [ '3.6', '3.7', '3.8' ]
+        python-version: [ '3.5', '3.6', '3.7', '3.8' ]
     steps:
     - name: Checkout
       uses: actions/checkout@v1
@@ -26,4 +26,4 @@ jobs:
         pip install -e .[test]
     - name: Run the tests
       run: |
-        nosetests -v jupyter_server
+        pytest

.gitignore

@@ -33,6 +33,7 @@ src
 *.swp
 *.map
 .idea/
+.vscode/
 Read the Docs
 config.rst
 
@@ -41,3 +42,4 @@ config.rst
 
 package-lock.json
 geckodriver.log
+yarn.lock

.travis.yml

@@ -0,0 +1,73 @@
+# http://travis-ci.org/#!/ipython/ipython
+language: python
+
+cache:
+    directories:
+        - $HOME/.cache/bower
+        - $HOME/.cache/pip
+env:
+  global:
+    - PATH=$TRAVIS_BUILD_DIR/pandoc:$PATH
+  matrix:
+    - GROUP=python
+
+before_install:
+    - pip install --upgrade pip
+    - pip install --upgrade setuptools wheel nose coverage codecov
+    - |
+      if [[ $GROUP == docs ]]; then
+        pip install -r docs/doc-requirements.txt
+        pip install --upgrade pytest
+      fi
+
+install:
+    - pip install --pre .[test] $EXTRA_PIP
+    - pip freeze
+    - wget https://github.com/jgm/pandoc/releases/download/1.19.1/pandoc-1.19.1-1-amd64.deb && sudo dpkg -i pandoc-1.19.1-1-amd64.deb
+
+script:
+    - jupyter kernelspec list
+    - |
+      symlinks=$(find . -type l| grep -v './git-hooks')
+      if [[ $(echo $symlinks) ]]; then
+          echo "Repository contains symlinks which won't work on windows:"
+          echo $symlinks
+          echo ""
+          false
+      else
+          true
+      fi
+    - 'if [[ $GROUP == python ]]; then pytest; fi'
+    - |
+      if [[ $GROUP == docs ]]; then
+        EXIT_STATUS=0
+        make -C docs/ html || EXIT_STATUS=$?
+
+        if [[ $TRAVIS_EVENT_TYPE == cron ]]; then
+          make -C docs/ linkcheck || EXIT_STATUS=$?;
+        fi
+
+        exit $EXIT_STATUS
+      fi
+
+matrix:
+    include:
+        - python: 3.5
+          env: GROUP=python
+        - python: 3.6
+          env: GROUP=python
+        - python: 3.7
+          env: GROUP=python
+        - python: 3.8
+          env: GROUP=python
+        - python: 3.5
+          env: GROUP=docs
+        - python: 3.6
+          env: GROUP=docs
+        - python: 3.7
+          env: GROUP=docs
+        - python: 3.8
+          env: GROUP=docs
+
+after_success:
+    - codecov

CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [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
+
+### Added
+- `extension` submodule ([#48](https://github.com/jupyter/jupyter_server/pull/48))
+    - ExtensionApp - configurable JupyterApp-subclass for server extensions
+        - Most useful for Jupyter frontends, like Notebook, JupyterLab, nteract, voila etc.
+        - Launch with entrypoints
+        - Configure from file or CLI
+        - Add custom templates, static assets, handlers, etc.
+        - Static assets are served behind a `/static/<extension_name>` endpoint.
+        - Run server extensions in "standalone mode" ([#70](https://github.com/jupyter/jupyter_server/pull/70) and [#76](https://github.com/jupyter/jupyter_server/pull/76))
+    - ExtensionHandler - tornado handlers for extensions.
+        - Finds static assets at `/static/<extension_name>`
+
+### Changed
+- `jupyter serverextension <command>` entrypoint has been changed to `jupyter server extension <command>`.
+- `toggle_jupyter_server` and `validate_jupyter_server` function no longer take a Logger object as an argument.
+- Changed testing framework from nosetests to pytest ([#152](https://github.com/jupyter/jupyter_server/pull/152))
+    - Depend on pytest-tornasync extension for handling tornado/asyncio eventloop
+    - Depend on pytest-console-scripts for testing CLI entrypoints
+- Added Github actions as a testing framework along side Travis and Azure ([#146](https://github.com/jupyter/jupyter_server/pull/146))
+
+### Removed
+- Removed the option to update `root_dir` trait in FileContentsManager and MappingKernelManager in ServerApp ([#135](https://github.com/jupyter/jupyter_server/pull/135))
+
+### Fixed
+- Synced Jupyter Server with Notebook PRs in batches (ended on 2019-09-27)
+    - [Batch 1](https://github.com/jupyter/jupyter_server/pull/95)
+    - [Batch 2](https://github.com/jupyter/jupyter_server/pull/97)
+    - [Batch 3](https://github.com/jupyter/jupyter_server/pull/98)
+    - [Batch 4](https://github.com/jupyter/jupyter_server/pull/99)
+    - [Batch 5](https://github.com/jupyter/jupyter_server/pull/103)
+    - [Batch 6](https://github.com/jupyter/jupyter_server/pull/104)
+    - [Batch 7](https://github.com/jupyter/jupyter_server/pull/105)
+    - [Batch 8](https://github.com/jupyter/jupyter_server/pull/106)
+
+### Security
+- Added a "secure_write to function for cookie/token saves ([#77](https://github.com/jupyter/jupyter_server/pull/77))

CONTRIBUTING.rst

@@ -69,7 +69,7 @@ To run the Python tests, use::
 
 If you want coverage statistics as well, you can run::
 
-    py.test --cov notebook -v --pyargs jupyter_server
+    py.test --cov notebook -v
 
 Building the Documentation
 --------------------------
@@ -82,7 +82,7 @@ containing all the necessary packages (except pandoc), use::
 
     conda env create -f docs/environment.yml
     source activate server_docs  # Linux and OS X
-    activate notebook_docs         # Windows
+    activate server_docs         # Windows
 
 .. _conda environment:
     https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file

README.md

@@ -1,7 +1,7 @@
 # Jupyter Server
 
 [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)
-[![Build Status](https://travis-ci.org/jupyter/jupyter_server.svg?branch=master)](https://travis-ci.org/jupyter/jupyter_server)
+[![Build Status](https://github.com/jupyter/jupyter_server/workflows/CI/badge.svg)](https://github.com/jupyter/jupyter_server/actions)
 [![Documentation Status](https://readthedocs.org/projects/jupyter-server/badge/?version=latest)](http://jupyter-server.readthedocs.io/en/latest/?badge=latest)
 
 The Jupyter Server provides the backend for Jupyter web applications such as
@@ -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

@@ -4,25 +4,36 @@ matrix:
 
 environment:
   matrix:
+    - CONDA_PY: 35
+      CONDA_PY_SPEC: 3.5
+      CONDA_INSTALL_LOCN: "C:\\Miniconda35-x64"
     - CONDA_PY: 36
+      CONDA_PY_SPEC: 3.6
       CONDA_INSTALL_LOCN: "C:\\Miniconda36-x64"
     - CONDA_PY: 37
-      CONDA_INSTALL_LOCN: "C:\\Miniconda36-x64"
+      CONDA_PY_SPEC: 3.7
+      CONDA_INSTALL_LOCN: "C:\\Miniconda37-x64"
     - CONDA_PY: 38
-      CONDA_INSTALL_LOCN: "C:\\Miniconda36-x64"
+      CONDA_PY_SPEC: 3.8
+      # appveyor doesn't come with this directory, so use 37's since we're creating an env anyway
+      CONDA_INSTALL_LOCN: "C:\\Miniconda37-x64"
 
 platform:
   - x64
 
-build: off
+build: false
 
 install:
   - cmd: call %CONDA_INSTALL_LOCN%\Scripts\activate.bat
+  - cmd: set CONDA_PY=%CONDA_PY%
+  - cmd: set CONDA_PY_SPEC=%CONDA_PY_SPEC%
   - cmd: conda config --set show_channel_urls true
   - cmd: conda config --add channels conda-forge
-  #- cmd: conda update --yes --quiet conda
-  - cmd: conda install -y pyzmq tornado jupyter_client nbformat nbconvert ipykernel pip nose
-  - cmd: pip install .[test]
+  - cmd: conda update --yes --quiet conda
+  - cmd: conda info -a
+  - 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 -e .[test]
 
 test_script:
-  - nosetests  -v jupyter_server --exclude-dir jupyter_server\tests\selenium
+  - pytest -s -v

docs/source/changelog.rst

@@ -21,9 +21,19 @@ We strongly recommend that you upgrade to version 9+ of pip before upgrading ``j
     Use ``pip install pip --upgrade`` to upgrade pip. Check pip version with
     ``pip --version``.
 
+.. _release-0.0.2:
+
+0.0.2
+-----
+
+- Introduce new extension module
+- Pytest for unit tests
+- Server documentation
+- NbClassic for migration from notebook
+
 .. _release-0.0.1:
 
 0.0.1
 -----
 
-First release of the Jupyter Server.
+- First release of the Jupyter Server.

docs/source/extending/handlers.rst

@@ -115,7 +115,7 @@ following:
         Called when the extension is loaded.
 
         Args:
-            nb_server_app (NotebookWebApplication): handle to the Notebook webserver instance.
+            nb_server_app: handle to the Notebook webserver instance.
         """
         web_app = nb_server_app.web_app
         host_pattern = '.*$'

docs/source/frontends.rst

@@ -11,10 +11,10 @@ Jupyter Server does not come with a frontend out-of-the-box; instead, a frontend
 Writing a frontend application
 ------------------------------
 
-Jupyter Server provides two key classes for writing a server frontend: 
+Jupyter Server provides two key classes for writing a server frontend:
 
     - ``ExtensionApp``
-    - ``ExtensionHandler``
+    - ``ExtensionHandlerMixin``
 
 The ExtensionApp:
 
@@ -28,7 +28,7 @@ To create a new Jupyter frontend application, subclass the ``ExtensionApp`` like
 
 .. code-block:: python
 
-    from jupyter_server.extension import ExtensionApp
+    from jupyter_server.extension.application import ExtensionApp
 
 
     class MyFrontend(ExtensionApp):
@@ -38,7 +38,7 @@ To create a new Jupyter frontend application, subclass the ``ExtensionApp`` like
         default_url = 'myfrontend'
         load_other_extensions = True
 
-        # --- ExtensionApp traits you can configure --- 
+        # --- ExtensionApp traits you can configure ---
         static_paths = [...]
         template_paths = [...]
         settings = {...}
@@ -61,7 +61,7 @@ To create a new Jupyter frontend application, subclass the ``ExtensionApp`` like
         def initialize_templates(self):
             ...
             # Change the jinja templating environment
-            self.settings.update({'myfrontend_jinja2_env': ...}) 
+            self.settings.update({'myfrontend_jinja2_env': ...})
 
 The ``ExtensionApp`` uses the following methods and properties to connect your frontend to the Jupyter server. Overwrite these pieces to add your custom settings, handlers and templates:
 
@@ -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.handler 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.
@@ -121,7 +121,7 @@ To make your frontend executable from anywhere on your system, added this method
 
     from setuptools import setup
 
-    
+
     setup(
         name='myfrontend',
         ...
@@ -131,3 +131,9 @@ To make your frontend executable from anywhere on your system, added this method
             ]
         }
     )
+
+Examples
+--------
+
+You can check some simple example on the `GitHub jupyter_server repository
+<https://github.com/jupyter/jupyter_server/tree/master/examples/simple>`_.