Standalone pip package (jupyterlab#415)

* Standalone pip package

* Move python tests in package

* Correct travis script

* Use yarn and add conda for server manager

* Install from sdist

Author: fcollonval

Diff for: .gitignore

@@ -105,3 +105,5 @@ node_modules/
 .vscode/
 
 package-lock.json
+MANIFEST
+jupyterlab_git/labextension/*.tgz

Diff for: .travis.yml

@@ -5,15 +5,14 @@ cache:
   pip: true
   directories:
     - /home/travis/.yarn-cache/
-install: pip install pytest "jupyterlab>=1.0.3"
 script:
-  - pytest tests/unit
-  - yarn
-  - yarn build
-  - yarn test
-  - pip install .
-  - jupyter serverextension enable --py jupyterlab_git
-  - jupyter labextension install .
+  - python setup.py sdist
+  - pip install --find-links=dist jupyterlab_git[test]
+  - pytest jupyterlab_git
+  - jlpm install
+  - jlpm run build
+  - jlpm run test
+  - jupyter lab build
   - python -m jupyterlab.browser_check
-  - yarn run lint
-  - python -m tests.test-browser.run_browser_test
+  - jlpm run lint
+  - python tests/test-browser/run_browser_test.py

Diff for: MANIFEST.in

@@ -0,0 +1,27 @@
+include LICENSE
+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 src
+graft style
+prune **/node_modules
+prune lib
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints

Diff for: README.md

@@ -20,9 +20,8 @@ A JupyterLab extension for version control using git
 To install perform the following steps:
 
 ```bash
-jupyter labextension install @jupyterlab/git
 pip install --upgrade jupyterlab-git
-jupyter serverextension enable --py jupyterlab_git
+jupyter lab build
 ```
 
 ## Development
@@ -59,24 +58,20 @@ Requires node 4+ and npm 4+
 # Clone the repo to your local environment
 git clone https://github.com/jupyterlab/jupyterlab-git.git
 cd jupyterlab-git
-# Install dependencies
-npm install # or yarn
+# Install the server extension in development mode
+pip install -e .
+jupyter serverextension enable --py jupyterlab_git
+# Install Javascript dependencies
+jlpm install
 # Build Typescript source
-npm run build # or yarn build
+jlpm run build
 # Link your development version of the extension with JupyterLab
 jupyter labextension link .
-# Rebuild Typescript source after making changes
-npm run build # or yarn build
-```
-
-```bash
-pip install .
-jupyter serverextension enable --py jupyterlab_git
 ```
 
-To rebuild the package and the JupyterLab app:
+To rebuild the package after a change and the JupyterLab app:
 
 ```bash
-npm run build
+jlpm run build
 jupyter lab build
 ```

Diff for: jupyter-config/jupyter_notebook_config.d/jupyterlab_git.json

@@ -0,0 +1,7 @@
+{
+    "NotebookApp": {
+      "nbserver_extensions": {
+        "jupyterlab_git": true
+      }
+    }
+  }

Diff for: jupyterlab_git/README.md

@@ -0,0 +1,5 @@
+# Copyright (c) Project Jupyter.
+# Distributed under the terms of the Modified BSD License.
+
+version_info = (0, 8, 2)
+__version__ = ".".join(map(str, version_info))

Diff for: jupyterlab_git/_version.py

@@ -5,16 +5,22 @@
   "main": "lib/index.js",
   "style": "style/index.css",
   "license": "BSD-3-Clause",
-  "author": "Git Intern Team - Jenna Landy, Noah Stapp, Alena Mueller; AWS - Jaipreet Singh, Neelam Gehlot; Quansight - Saul Shanabrook",
+  "author": "Jupyter Development Team",
   "keywords": [
     "jupyter",
     "jupyterlab",
     "jupyterlab-extension"
   ],
   "scripts": {
-    "build": "tsc",
-    "clean": "rimraf lib",
-    "prepublish": "npm run build",
+    "build": "yarn run build:lib",
+    "build:labextension": "cd jupyterlab_git && rimraf labextension && mkdirp labextension && cd labextension && npm pack ../..",
+    "build:lib": "tsc",
+    "build:all": "yarn run build:labextension",
+    "clean": "yarn run clean:lib",
+    "clean:lib": "rimraf lib",
+    "clean:labextension": "rimraf jupyterlab_git/labextension",
+    "clean:all": "yarn run clean:lib && yarn run clean:labextension",
+    "prepare": "yarn run clean && yarn run build",
     "watch": "tsc -w",
     "test": "jest",
     "lint": "tslint --project .",
@@ -30,7 +36,8 @@
     "discovery": {
       "server": {
         "managers": [
-          "pip"
+          "pip",
+          "conda"
         ],
         "base": {
           "name": "jupyterlab-git"

Diff for: tests/__init__.py renamed to jupyterlab_git/tests/__init__.py

@@ -1,22 +1,91 @@
 """
 Setup Module to setup Python Handlers (Git Handlers) for the Git Plugin.
 """
+from os.path import join as pjoin
+
+from setupbase import (
+    create_cmdclass, install_npm, ensure_targets,
+    find_packages, combine_commands, ensure_python,
+    get_version, HERE
+)
+
 import setuptools
 
+# The name of the project
+name='jupyterlab_git'
+
+# Ensure a valid python version
+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'),
+]
+
+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'),
+    ensure_targets(jstargets),
+)
+
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
-setuptools.setup(
-    name='jupyterlab_git',
-    version='0.8.1',
-    author='Git Intern Team - Noah Stapp, Jenna Landy, Alena Mueller; AWS - Jaipreet Singh, Neelam Gehlot; Quansight - Saul Shanabrook',
-    description="A server extension for JupyterLab's git extension",
-    long_description=long_description,
+setup_args = dict(
+    name            = name,
+    description     = "A server extension for JupyterLab's git extension",
+    long_description= long_description,
     long_description_content_type="text/markdown",
-    packages=setuptools.find_packages(),
-    install_requires=[
+    version         = version,
+    cmdclass        = cmdclass,
+    packages        = setuptools.find_packages(),
+    author          = 'Jupyter Development Team',
+    url             = 'https://github.com/jupyterlab/jupyterlab-git',
+    license         = 'BSD',
+    platforms       = "Linux, Mac OS X, Windows",
+    keywords        = ['Jupyter', 'JupyterLab', 'Git'],
+    classifiers     = [
+        'Intended Audience :: Developers',
+        'Intended Audience :: Science/Research',
+        'License :: OSI Approved :: BSD License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Framework :: Jupyter',
+    ],
+    include_package_data = True,
+    install_requires = [
         'notebook',
-        'nbdime >= 1.1.0'
+        'nbdime >= 1.1.0',
     ],
-    package_data={'jupyterlab_git': ['*']},
+    extras_require = {
+        'test': [
+            'pytest',
+            'jupyterlab>=1.0.3',
+        ],
+    },
 )
+
+setuptools.setup(**setup_args)