Merge pull request #458 from telamonian/fix-unipython-build-release

Prep for release of unibundle to Pypi: removed redundant files and eliminated redundant rebuilds

Author: fcollonval

.travis.yml

@@ -9,10 +9,11 @@ before_install:
   - nvm install 10
 install: pip install pytest "jupyterlab~=1.1"
 script:
+  # 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
+  # Install the extension dependencies based on the current setup.py
   - pip install jupyterlab_git[test]
   - jupyter labextension list
   - jupyter lab build

MANIFEST.in

@@ -3,23 +3,6 @@ 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
 ```
 
+### Troubleshooting
+
+- 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 by running:
+
+```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,12 @@
     "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:labextension": "jlpm build && jlpm clean:labextension && mkdirp jupyterlab_git/labextension && cd jupyterlab_git/labextension && npm pack ../..",
+    "clean": "rimraf lib tsconfig.tsbuildinfo",
+    "clean:more": "jlpm clean && rimraf build dist MANIFEST",
     "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,100 @@
+#!/usr/bin/env python
+import argparse as argpar
+import json
+import subprocess
+
+from setupbase import get_version
+
+VERSION_PY = 'jupyterlab_git/_version.py'
+
+def prepLabextensionBundle():
+    subprocess.run(['jlpm', 'clean:slate'])
+
+def tag(version, dryrun=False, kind=None):
+    """git tagging
+    """
+    kw = {'version': version, 'kind': kind}
+    tag = '{kind}_v{version}'.format(**kw) if kind else 'v{version}'.format(**kw)
+
+    if dryrun:
+        print("Would tag: {}".format(tag))
+    else:
+        subprocess.run(['git', 'tag', tag])
+        subprocess.run(['git', 'push', 'origin', tag])
+
+def pypi(wheel=True, test=False):
+    """release on pypi
+    """
+    if wheel:
+        # build the source (sdist) and binary wheel (bdist_wheel) 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(dryrun=False, version=None):
+    if version:
+        force_ver_cmd = ['npm', '--no-git-tag-version', 'version', version, '--force', '--allow-same-version']
+        if dryrun:
+            print("Would force npm version with: {}".format(' '.join(force_ver_cmd)))
+        else:
+            # force the labextension version to match the supplied version
+            subprocess.run(force_ver_cmd)
+    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(VERSION_PY)
+
+def doRelease(test=False):
+    # prep the build area for the labextension bundle
+    prepLabextensionBundle()
+
+    # treat the serverextension version as the "real" single source of truth
+    version = serverExtensionVersion()
+    # force the labextension version to agree with the serverextension version
+    labExtensionVersion(dryrun=test, version=version)
+
+    # tag with version and push the tag
+    tag(dryrun=test, version=version)
+
+    # release to pypi and npmjs
+    pypi(test=test)
+    npmjs(dryrun=test)
+
+def main():
+    parser = argpar.ArgumentParser()
+
+    parser.add_argument('--test', action='store_true',
+        help='Release to Pypi test server; performs a dryrun of all other release actions')
+
+    parsed = vars(parser.parse_args())
+
+    doRelease(test=parsed['test'])
+
+if __name__=='__main__':
+    main()

setup.py

@@ -1,12 +1,14 @@
+"""Setup Module to setup Python serverextension for the jupyterlab git
+extension. For non-dev installs, will also automatically
+build (if package.json is present) and install (if the labextension exists,
+eg the build succeeded) the corresponding labextension.
 """
-Setup Module to setup Python Handlers (Git Handlers) for the Git Plugin.
-"""
-from os.path import join as pjoin
+from pathlib import Path
+from subprocess import CalledProcessError
 
 from setupbase import (
-    create_cmdclass, install_npm, ensure_targets,
-    combine_commands, ensure_python, get_version,
-    HERE
+    command_for_func, create_cmdclass, ensure_python,
+    get_version, HERE, run
 )
 
 import setuptools
@@ -18,36 +20,27 @@
 ensure_python('>=3.5')
 
 # Get our version
-version = get_version(pjoin(name, '_version.py'))
-
-lab_path = pjoin(HERE, name, 'labextension')
-
-# Representative files that should exist after a successful build
-jstargets = [
-    pjoin(HERE, 'lib', 'git.js'),
-]
+version = get_version(str(Path(name) / '_version.py'))
 
-package_data_spec = {
-    name: [
-        '*'
-    ]
-}
+lab_path = Path(HERE) / name / 'labextension'
 
 data_files_spec = [
-    ('share/jupyter/lab/extensions', lab_path, '*.tgz'),
+    ('share/jupyter/lab/extensions', str(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
-)
+def runPackLabextension():
+    if Path('package.json').is_file():
+        try:
+            run(['jlpm', 'build:labextension'])
+        except CalledProcessError:
+            pass
+pack_labext = command_for_func(runPackLabextension)
 
-cmdclass['jsdeps'] = combine_commands(
-    install_npm(HERE, build_cmd='build:all', npm='jlpm'),
-    ensure_targets(jstargets),
-)
+cmdclass = create_cmdclass('pack_labext', data_files_spec=data_files_spec)
+cmdclass['pack_labext'] = pack_labext
+cmdclass.pop('develop')
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
@@ -76,7 +69,6 @@
         'Programming Language :: Python :: 3.7',
         'Framework :: Jupyter',
     ],
-    include_package_data = True,
     install_requires = [
         'notebook',
         'nbdime >= 1.1.0',
@@ -85,7 +77,7 @@
     extras_require = {
         'test': [
             'pytest',
-            'jupyterlab~=1.0',
+            'jupyterlab~=1.1',
         ],
     },
 )