fixed up the unified build and bundle for release on pypi

- No more pointless ts/js sources outside of the bundled labextension .tar.gz
- No more pointless Typescript rebuilds/npm packing (eg when creating a wheel from the sdist)
- The enduser no longer needs node to build from the sdist
- Single unified versioning, based on the current python package version
- Added release.py script to paritally automate release

Author: telamonian

.travis.yml

@@ -9,11 +9,14 @@ before_install:
   - nvm install 10
 install: pip install pytest "jupyterlab~=1.1"
 script:
+  # Build the labextension and bundle it
+  - jlpm build:labextension
+  # Build the sdist (identical to what will be uploaded to eg pypi on release)
   - python setup.py sdist
-  # Install the extension ensuring the cache is unused
+  # Install the extension from the sdist ensuring the cache is unused
   - pip install jupyterlab_git[test] --pre --no-index --find-links=dist --no-deps --no-cache-dir -v
-  # Install the extension dependencies
-  - pip install jupyterlab_git[test]
+  # Install the extension dependencies based on the current setup.py
+  - pip install .[test]
   - jupyter labextension list
   - jupyter lab build
   - pytest jupyterlab_git -r ap

MANIFEST.in

@@ -3,23 +3,8 @@ include README.md
 
 include setupbase.py
 
-include package.json
-include *.config.js
-include setupJest.js
-include ts*.json
 include jupyterlab_git/labextension/*.tgz
 
-# Tests
-graft tests
-prune tests/build
-
-# Javascript files
-graft schema
-graft src
-graft style
-prune **/node_modules
-prune lib
-
 # Patterns to exclude from any directory
 global-exclude *~
 global-exclude *.pyc

README.md

@@ -24,6 +24,14 @@ pip install --upgrade jupyterlab-git
 jupyter lab build
 ```
 
+### Troubleshoot
+
+- When you run JupyterLab, if you can see the Git sidepanel UI but you cannot get it to work, you may need to explicitly enable the serverextension. Do:
+
+```bash
+jupyter serverextension enable --py jupyterlab_git
+```
+
 ## Development
 
 ### Contributing
@@ -55,17 +63,19 @@ If you would like to be listed, please submit a pull request with your informati
 Requires node 4+ and npm 4+
 
 ```bash
+# Install new-ish JupyterLab
+pip install -U jupyterlab
+
 # Clone the repo to your local environment
 git clone https://github.com/jupyterlab/jupyterlab-git.git
 cd jupyterlab-git
-# Install JupyterLab
-pip install jupyterlab
-# Install Javascript dependencies
-jlpm install
-# Install the server extension in development mode
+
+# Install the server extension in development mode and enable it
 pip install -e .[test]
 jupyter serverextension enable --py jupyterlab_git
-# Link your development version of the extension with JupyterLab
+
+# Build the labextension and dev-mode link it to jlab
+jlpm build
 jupyter labextension link .
 ```
 
@@ -81,4 +91,4 @@ To execute the tests
 ```bash
 pytest jupyterlab_git
 jlpm run test
-```
+```

package.json

@@ -12,15 +12,13 @@
     "jupyterlab-extension"
   ],
   "scripts": {
-    "build": "jlpm run build:lib",
-    "build:labextension": "cd jupyterlab_git && rimraf labextension && mkdirp labextension && cd labextension && npm pack ../..",
-    "build:lib": "tsc",
-    "build:all": "jlpm run build:labextension",
-    "clean": "jlpm run clean:lib",
-    "clean:lib": "rimraf lib && rimraf tsconfig.tsbuildinfo",
+    "build": "jlpm install && tsc",
+    "build:clean": "jlpm install && jlpm clean && tsc",
+    "build:labextension": "jlpm build:clean && jlpm clean:labextension && mkdirp jupyterlab_git/labextension && cd jupyterlab_git/labextension && npm pack ../..",
+    "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
+    "clean:more": "jlpm clean && rimraf build && rimraf dist && rimraf package && rimraf *.tgz",
     "clean:labextension": "rimraf jupyterlab_git/labextension",
-    "clean:all": "jlpm run clean:lib && jlpm run clean:labextension",
-    "prepare": "jlpm run clean && jlpm run build",
+    "clean:slate": "jlpm clean:more && jlpm clean:labextension && rimraf node_modules",
     "watch": "tsc -w",
     "test": "jest",
     "lint": "tslint --project .",

release.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python
+
+import json
+import subprocess
+
+from setupbase import get_version
+
+def buildBundle():
+    subprocess.run(['jlpm', 'clean:slate'])
+    subprocess.run(['jlpm', 'build:labextension'])
+
+def tag(version, kind=None):
+    """git tagging
+    """
+    kw = {'version': version, 'kind': kind}
+    tag = "{kind}_v{version}".format(**kw) if kind else "v{version}".format(**kw)
+
+    subprocess.run(['git', 'tag', tag])
+    subprocess.run(['git', 'push', 'origin', tag])
+
+def pypi(bdist=True, test=False):
+    """release on pypi
+    """
+    if bdist:
+        # build the source (sdist) and binary wheel (bdist) releases
+        subprocess.run(['python', 'setup.py', 'sdist', 'bdist_wheel'])
+    else:
+        # build just the source release
+        subprocess.run(['python', 'setup.py', 'sdist'])
+
+    if test:
+        # release to the test server
+        subprocess.run(['twine', 'upload', '--repository-url', 'https://test.pypi.org/legacy/', 'dist/*'])
+    else:
+        # release to the production server
+        subprocess.run(['twine', 'upload', 'dist/*'])
+
+def npmjs(dryRun=False):
+    """release on npmjs
+    """
+    if dryRun:
+        # dry run build and release
+        subprocess.run(['npm', 'publish', '--access', 'public', '--dry-run'])
+    else:
+        # build and release
+        subprocess.run(['npm', 'publish', '--access', 'public'])
+
+def labExtensionVersion(version=None):
+    if version:
+        # force the labextension version to match the supplied version
+        subprocess.run(['npm', '--no-git-tag-version', 'version', version, '--force', '--allow-same-version'])
+    else:
+        # get single source of truth from the Typescript labextension
+        with open('package.json') as f:
+            info = json.load(f)
+
+        version = info['version']
+
+    return version
+
+def serverExtensionVersion():
+    # get single source of truth from the Python serverextension
+    return get_version('jupyterlab_hdf/_version.py')
+
+def doRelease():
+    # do a clean build of the bundle
+    buildBundle()
+
+    # treat the serverextension version as the "real" single source of truth
+    version = serverExtensionVersion()
+    # force the labextension version to agree with the serverextension version
+    labExtensionVersion(version=version)
+
+    # tag with version and push the tag
+    tag(version=version)
+
+    # release to pypi and npmjs
+    pypi()
+    npmjs()
+
+if __name__=="__main__":
+    doRelease()

setup.py

@@ -4,8 +4,7 @@
 from os.path import join as pjoin
 
 from setupbase import (
-    create_cmdclass, install_npm, ensure_targets,
-    combine_commands, ensure_python, get_version,
+    create_cmdclass, ensure_python, get_version,
     HERE
 )
 
@@ -22,32 +21,13 @@
 
 lab_path = pjoin(HERE, name, 'labextension')
 
-# Representative files that should exist after a successful build
-jstargets = [
-    pjoin(HERE, 'lib', 'git.js'),
-]
-
-package_data_spec = {
-    name: [
-        '*'
-    ]
-}
-
 data_files_spec = [
     ('share/jupyter/lab/extensions', lab_path, '*.tgz'),
     ('etc/jupyter/jupyter_notebook_config.d',
      'jupyter-config/jupyter_notebook_config.d', 'jupyterlab_git.json'),
 ]
 
-cmdclass = create_cmdclass('jsdeps', 
-    package_data_spec=package_data_spec,
-    data_files_spec=data_files_spec
-)
-
-cmdclass['jsdeps'] = combine_commands(
-    install_npm(HERE, build_cmd='build:all', npm='jlpm'),
-    ensure_targets(jstargets),
-)
+cmdclass = create_cmdclass(data_files_spec=data_files_spec)
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
@@ -76,7 +56,7 @@
         'Programming Language :: Python :: 3.7',
         'Framework :: Jupyter',
     ],
-    include_package_data = True,
+    # include_package_data = True,
     install_requires = [
         'notebook',
         'nbdime >= 1.1.0',
@@ -85,7 +65,7 @@
     extras_require = {
         'test': [
             'pytest',
-            'jupyterlab~=1.0',
+            'jupyterlab~=1.1',
         ],
     },
 )