Use Jupyter Packaging

Author: jtpio

.github/workflows/codeql-analysis.yml

@@ -14,7 +14,7 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ '*' ]
+    branches: [ 'master' ]
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ master ]

.github/workflows/python-linux.yml

@@ -1,7 +1,7 @@
 name: Jupyter Server Tests [Linux]
 on:
   push:
-    branches: '*'
+    branches: 'master'
   pull_request:
     branches: '*'
 jobs:
@@ -37,7 +37,7 @@ jobs:
           ${{ runner.os }}-pip-
     - name: Install the Python dependencies
       run: |
-        pip install -e .[test] codecov
+        pip install -e ".[test]" codecov
     - name: List installed packages
       run: |
         pip freeze
@@ -62,7 +62,19 @@ jobs:
         codecov
     - name: Test full install
       run: |
-            pip uninstall -y jupyter_server
-            pip install .
-            cd /tmp
-            pytest --pyargs jupyter_server
+        python -m venv test_install
+        ./test_install/bin/python -m pip install -U pip
+        ./test_install/bin/python -m pip install ".[test]"
+        pushd test_install
+        ./bin/pytest --pyargs jupyter_server
+        popd
+    - name: Check the Manifest
+      run: |
+        pip install check-manifest
+        git clean -dfx
+        check-manifest -v
+    - name: Check Version Bump
+      run: |
+        pip install tbump
+        tbump --non-interactive --only-patch 100.1.1
+        git checkout .

.github/workflows/python-macos.yml

@@ -1,7 +1,7 @@
 name: Jupyter Server Tests [Mac OS]
 on:
   push:
-    branches: '*'
+    branches: 'master'
   pull_request:
     branches: '*'
 jobs:

.github/workflows/python-windows.yml

@@ -1,7 +1,7 @@
 name: Jupyter Server Tests [Windows]
 on:
   push:
-    branches: '*'
+    branches: 'master'
   pull_request:
     branches: '*'
 jobs:

CHANGELOG.md

@@ -4,7 +4,6 @@ All notable changes to this project will be documented in this file.
 
 ## 1.6.1
 
-
 ([Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/1.6.0...2756a29c5fdcfa62a3492004627541089d53d14f))
 
 ### Merged PRs
@@ -94,7 +93,6 @@ All notable changes to this project will be documented in this file.
 
 [@afshin](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Aafshin+updated%3A2021-02-22..2021-03-23&type=Issues) | [@blink1073](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Ablink1073+updated%3A2021-02-22..2021-03-23&type=Issues) | [@codecov-io](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Acodecov-io+updated%3A2021-02-22..2021-03-23&type=Issues) | [@jtpio](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Ajtpio+updated%3A2021-02-22..2021-03-23&type=Issues) | [@kevin-bates](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Akevin-bates+updated%3A2021-02-22..2021-03-23&type=Issues) | [@kiendang](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Akiendang+updated%3A2021-02-22..2021-03-23&type=Issues) | [@minrk](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Aminrk+updated%3A2021-02-22..2021-03-23&type=Issues) | [@sngyo](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Asngyo+updated%3A2021-02-22..2021-03-23&type=Issues) | [@Zsailer](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3AZsailer+updated%3A2021-02-22..2021-03-23&type=Issues)
 
-
 ## [1.4.1](https://github.com/jupyter-server/jupyter_server/tree/1.4.1) (2021-02-22)
 
 [Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/1.4.0...bc252d33de2f647f98d048dc32888f0a83f005ac)
@@ -112,10 +110,8 @@ All notable changes to this project will be documented in this file.
 
 [@jamesmishra](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Ajamesmishra+updated%3A2021-02-18..2021-02-22&type=Issues) | [@Zsailer](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3AZsailer+updated%3A2021-02-18..2021-02-22&type=Issues)
 
-
 ## [1.4.0](https://github.com/jupyter-server/jupyter_server/tree/1.4.0) (2021-02-18)
 
-
 [Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/1.3.0...HEAD)
 
 **Merged pull requests:**
@@ -130,7 +126,6 @@ All notable changes to this project will be documented in this file.
 - \[Gateway\] Track only this server's kernels [\#407](https://github.com/jupyter-server/jupyter_server/pull/407) ([kevin-bates](https://github.com/kevin-bates))
 - Update manager.py: more descriptive warnings when extensions fail to load [\#396](https://github.com/jupyter-server/jupyter_server/pull/396) ([alberti42](https://github.com/alberti42))
 
-
 ## [1.3.0](https://github.com/jupyter-server/jupyter_server/tree/1.3.0) (2021-02-04)
 
 [Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/1.2.2...HEAD)
@@ -161,7 +156,6 @@ This was a broken release and was yanked from PyPI.
 - Increase culling test idle timeout [\#388](https://github.com/jupyter-server/jupyter_server/pull/388) ([kevin-bates](https://github.com/kevin-bates))
 - update changelog for 1.2.2 [\#387](https://github.com/jupyter-server/jupyter_server/pull/387) ([Zsailer](https://github.com/Zsailer))
 
-
 ## [1.2.2](https://github.com/jupyter-server/jupyter_server/tree/1.2.2) (2021-01-14)
 
 **Merged pull requests:**
@@ -172,7 +166,6 @@ This was a broken release and was yanked from PyPI.
 - Replace secure\_write, is\_hidden, exists with jupyter\_core's [\#382](https://github.com/jupyter-server/jupyter_server/pull/382) ([kevin-bates](https://github.com/kevin-bates))
 - Add --autoreload flag [\#380](https://github.com/jupyter-server/jupyter_server/pull/380) ([afshin](https://github.com/afshin))
 
-
 ## [1.2.1](https://github.com/jupyter-server/jupyter_server/tree/1.2.1) (2021-01-08)
 
 [Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/1.2.0...1.2.1)
@@ -221,7 +214,6 @@ This was a broken release and was yanked from PyPI.
 
 - Nudge kernel with info request until we receive IOPub messages [\#361](https://github.com/jupyter-server/jupyter_server/pull/361) ([SylvainCorlay](https://github.com/SylvainCorlay))
 
-
 ## [1.1.1](https://github.com/jupyter-server/jupyter_server/tree/1.1.1) (2020-12-16)
 
 [Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/1.1.0...1.1.1)
@@ -230,7 +222,6 @@ This was a broken release and was yanked from PyPI.
 
 - Fix: await possible async dir\_exists method [\#363](https://github.com/jupyter-server/jupyter_server/pull/363) ([mwakaba2](https://github.com/mwakaba2))
 
-
 ## 1.1.0 (2020-12-11)
 
 [Full Changelog](https://github.com/jupyter-server/jupyter_server/compare/1.0.10...1.1.0)
@@ -252,7 +243,6 @@ This was a broken release and was yanked from PyPI.
 - Enable CodeQL runs on all pushed branches [\#333](https://github.com/jupyter-server/jupyter_server/pull/333) ([kevin-bates](https://github.com/kevin-bates))
 - Asynchronous Contents API [\#324](https://github.com/jupyter-server/jupyter_server/pull/324) ([mwakaba2](https://github.com/mwakaba2))
 
-
 ## 1.0.6 (2020-11-18)
 
 1.0.6 is a security release, fixing one vulnerability:
@@ -261,7 +251,6 @@ This was a broken release and was yanked from PyPI.
 
 - Fix open redirect vulnerability GHSA-grfj-wjv9-4f9v (CVE-2020-26232)
 
-
 ## 1.0 (2020-9-18)
 
 ### Added.
@@ -293,15 +282,13 @@ This was a broken release and was yanked from PyPI.
 * Changed ExtensionApp mixin to inherit from `HasTraits`. This broke in traitlets 5.0 ([294](https://github.com/jupyter/jupyter_server/pull/294))
 * Replaces `urlparse` with `url_path_join` to prevent URL squashing issues. ([304](https://github.com/jupyter/jupyter_server/pull/304))
 
-
 ## [0.3] - 2020-4-22
 
 ### Added
 
 - ([#191](https://github.com/jupyter/jupyter_server/pull/191)) Async kernel managment is now possible using the `AsyncKernelManager` from `jupyter_client`
 - ([#201](https://github.com/jupyter/jupyter_server/pull/201)) Parameters can now be passed to new terminals created by the `terminals` REST API.
 
-
 ### Changed
 
 - ([#196](https://github.com/jupyter/jupyter_server/pull/196)) Documentation was rewritten + refactored to use pydata_sphinx_theme.
@@ -311,7 +298,6 @@ This was a broken release and was yanked from PyPI.
 
 - ([#194](https://github.com/jupyter/jupyter_server/pull/194)) The bundlerextension entry point was removed.
 
-
 ## [0.2.1] - 2020-1-10
 
 ### Added

CONTRIBUTING.rst

@@ -99,4 +99,4 @@ Windows users can find ``make.bat`` in the ``docs`` folder.
 
 You should also have a look at the `Project Jupyter Documentation Guide`__.
 
-__ https://jupyter.readthedocs.io/en/latest/contrib_docs/index.html
+__ https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html

MANIFEST.in

@@ -4,6 +4,7 @@ include README.md
 include RELEASE.md
 include CHANGELOG.md
 include setupbase.py
+include package.json
 
 # include everything in package_data
 recursive-include jupyter_server *

README.md

@@ -12,7 +12,7 @@ For more information, read our [documentation here](http://jupyter-server.readth
 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
+    pip install jupyter_server
 
 Jupyter Server currently supports Python>=3.6 on Linux, OSX and Windows.
 
@@ -31,14 +31,14 @@ To see the changes between releases, checkout the [CHANGELOG](https://github.com
 
 Launch with:
 
-    $ jupyter server
+    jupyter server
 
 ### Testing
 
 To test an installed `jupyter_server`, run the following:
 
-    $ pip install jupyter_server[test]
-    $ pytest jupyter_server
+    pip install jupyter_server[test]
+    pytest jupyter_server
 
 ## Contributing
 

RELEASE.md

@@ -1,41 +1,44 @@
 # Making a Jupyter Server Release
 To create a release, perform the following steps...
 
-## Remove untracked files
+## Set up
 ```
+pip install tbump twine build
+git pull origin $(git branch --show-current)
 git clean -dffx
 ```
 
 ## Update the version and apply the tag
 ```
-vim jupyter_server/_version.py
-export script_version=`python setup.py --version 2>/dev/null`
-git commit -a -m "Release $script_version"
-git tag $script_version
+echo "Enter new version"
+read script_version
+tbump ${script_version}
+git commit -a -m "Release ${script_version}"
+git tag $script_version -m "Release ${script_version}"
 ```
 
 ## Build the artifacts
 ```
 rm -rf dist
-python setup.py sdist
-python setup.py bdist_wheel
+python -m build .
 ```
 
 ## Update the version back to dev
 ```
-vim jupyter_server/_version.py
+echo "Enter dev version"
+read dev_version
+tbump ${dev_version}
 git commit -a -m "Back to dev version"
 ```
 
 ## Push the commits and tag
 ```
-git push --all
-git push --tags
+git push origin $(git branch --show-current)
+git push origin --tags
 ```
 
 ## Publish the artifacts to pypi
 ```
-pip install twine
-twine check dist/* 
+twine check dist/*
 twine upload dist/*
 ```

jupyter_server/_version.py

@@ -2,14 +2,8 @@
 store the current version info of the server.
 
 """
+from jupyter_packaging import get_version_info
 
-# Downstream maintainer, when running `python.setup.py jsversion`,
-# the version string is propagated to the JavaScript files,  do not forget to
-# patch the JavaScript files in `.postN` release done by distributions.
-
-# Next beta/alpha/rc release: The version number for beta is X.Y.ZbN **without dots**.
-# However, be sure to INCLUDE a dot prefix when adding the dev release: X.Y.Z.devN
-# See: https://www.python.org/dev/peps/pep-0440/#public-version-identifiers
-
-version_info = (1, 7, 0, '.dev0')
-__version__ = '.'.join(map(str, version_info[:3])) + ''.join(version_info[3:])
+# Version string must appear intact for tbump versioning
+__version__ = '1.7.0.dev0'
+version_info = get_version_info(__version__)