Merge pull request #71 from bollwyvl/gh-70-remove-hard-lab-dependency

Remove hard lab dependency

Author: krassowski

README.md

@@ -156,23 +156,37 @@ jupyter labextension install @krassowski/jupyterlab-lsp@0.5.0-rc.0
 
 ## Development
 
-For a development install (requires npm version 4 or later), do the following in the repository directory:
+For a development install (requires `nodejs` 8 or later and `jupyterlab` 1.1),
+run the following in the repository directory:
 
 ```bash
-npm install
-npm run build
-jupyter labextension link .
+jlpm
+jlpm build
+jupyter labextension install .
 ```
 
 To rebuild the package and the JupyterLab app:
 
 ```bash
-npm run build
+jlpm build
 jupyter lab build
 ```
 
-To run tests suite:
+To watch the files and build continuously:
 
 ```bash
-npm test
+jlpm watch           # leave this running...
+jupyter lab --watch  # ...in another terminal
+```
+
+To check and fix code style:
+
+```bash
+jlpm lint
+```
+
+To run test the suite:
+
+```bash
+jlpm test
 ```

py_src/jupyter_lsp/CONTRIBUTING.md

@@ -157,6 +157,15 @@ python scripts/utest.py
 
 ### Browser-based Acceptance Tests
 
+The browser tests will launch JupyterLab on a random port and exercise the
+Language Server features with [Robot Framework][] and [SeleniumLibrary][].
+
+[robot framework]: https://github.com/robotframework/robotframework
+[seleniumlibrary]: https://github.com/robotframework/seleniumlibrary
+
+First, ensure you've prepared JupyterLab for `jupyterlab-lsp`
+[development](../../README.md#development).
+
 Prepare the enviroment:
 
 ```bash
@@ -165,14 +174,21 @@ conda env update -n jupyterlab-lsp --file environment-atest.yml
 pip install -r requirements-atest.txt  # ... and install geckodriver, somehow
 ```
 
-> Also ensure you've `jupyter labextension install .`ed in the root of the repo
-
 Run the tests:
 
 ```bash
 python scripts/atest.py
 ```
 
+The Robot Framework reports and screenshots will be in `atest/output`, with
+`<operating system>_<python version>.log.html` being the most interesting
+artifacts, e.g.
+
+```
+- linux_37.log.html
+- linux_37.report.html
+```
+
 ### Formatting
 
 Minimal code style is enforced with `flake8` during unit testing. If installed,

py_src/jupyter_lsp/README.md

@@ -4,7 +4,7 @@
 > `notebook` or `lab` server. For Python 3.5+.
 
 See the parent of this repository, [jupyterlab-lsp](../../README.md) for the
-reference client implementation for [JupyterLab][]
+reference client implementation for [JupyterLab][].
 
 ## batteries expected
 

py_src/jupyter_lsp/types.py

@@ -1,12 +1,10 @@
 """ API used by spec finders and manager
 """
-import os
 import pathlib
 import shutil
 import sys
 from typing import Callable, Dict, List, Text
 
-from jupyterlab.commands import get_app_dir
 from notebook.transutils import _
 from traitlets import List as List_, Unicode, default
 from traitlets.config import LoggingConfigurable
@@ -58,20 +56,32 @@ def _default_nodejs(self):
 
     @default("node_roots")
     def _default_node_roots(self):
-        """ get the "usual suspects" for where node_modules may be found
+        """ get the "usual suspects" for where `node_modules` may be found
 
         - where this was launch (usually the same as NotebookApp.notebook_dir)
-        - the JupyterLab staging folder
+        - the JupyterLab staging folder (if available)
         - wherever conda puts it
         - wherever some other conventions put it
         """
-        return [
-            os.getcwd(),
-            pathlib.Path(get_app_dir()) / "staging",
-            pathlib.Path(sys.prefix) / "lib",
-            # TODO: "well-known" windows paths
-            sys.prefix,
-        ]
+
+        # check where the server was started first
+        roots = [pathlib.Path.cwd()]
+
+        # try jupyterlab staging next
+        try:
+            from jupyterlab import commands
+
+            roots += [pathlib.Path(commands.get_app_dir()) / "staging"]
+        except ImportError:  # pragma: no cover
+            pass
+
+        # conda puts stuff in $PREFIX/lib on POSIX systems
+        roots += [pathlib.Path(sys.prefix) / "lib"]
+
+        # ... but right in %PREFIX% on nt
+        roots += [pathlib.Path(sys.prefix)]
+
+        return roots
 
 
 # Gotta be down here so it can by typed... really should have a IL

requirements-atest.txt

@@ -1,3 +1,3 @@
 # acceptance test dependencies for jupyter_lsp
--r requirements.txt
+-r requirements-lab.txt
 robotframework-seleniumlibrary

requirements-dev.txt

@@ -1,4 +1,4 @@
-# development dependencies for jupyter_lsp for qa
+# development dependencies for jupyter_lsp for qa, with lab
 -r requirements-utest.txt
 pyls-black
 pyls-isort

requirements-lab.txt

@@ -0,0 +1,3 @@
+# the version of jupyterlab
+-r requirements.txt
+jupyterlab >=1.1,<1.2

requirements-utest.txt

@@ -1,5 +1,5 @@
 # test time dependencies for jupyter_lsp, including one language server
--r requirements.txt
+-r requirements-lab.txt
 flake8 >=3.5
 pytest-asyncio
 pytest-cov

requirements.txt

@@ -1,3 +1,3 @@
-# what is needed to run jupyter_lsp (but no servers)
-jupyterlab>=1.1,<1.2
+# what is needed to run jupyter_lsp (but no servers or lab)
+notebook
 setuptools

setup.cfg

@@ -21,17 +21,16 @@ classifiers =
     Programming Language :: Python
 
 [options]
-install_requires =
-    notebook
 package_dir =
     = py_src
+
 packages = find:
 include_package_data = True
 zip_safe = False
 
-tests_require =
-    pytest
-    pytest-cov
+install_requires =
+    notebook
+    entrypoints
 
 [options.packages.find]
 where =
@@ -42,7 +41,7 @@ jupyter_lsp_spec_v0 =
     bash-language-server = jupyter_lsp.specs:bash
     dockerfile-language-server-nodejs = jupyter_lsp.specs:dockerfile
     javascript-typescript-langserver = jupyter_lsp.specs:ts
-    pyls = jupyter_lsp.specs:py
+    python-language-server = jupyter_lsp.specs:py
     unified-language-server = jupyter_lsp.specs:md
     vscode-css-languageserver-bin = jupyter_lsp.specs:css
     vscode-html-languageserver-bin = jupyter_lsp.specs:html