Merge branch 'release/0.2.3'

README.md

@@ -50,6 +50,18 @@ $ jupyter --paths
 ```
 The `config` section from the output lists the directories where your `openbis-connections.yaml` file should be placed.
 
+## install Jupyter extension manually
+
+In most cases, a simple `pip install --upgrade jupyter-openbis-extension` will do. However, in some cases you need to issue the following commands to get the extension running correctly:
+
+```
+$ jupyter serverextension enable --py jupyter-openbis-extension
+$ jupyter nbextension install --py jupyter-openbis-extension --user
+$ jupyter nbextension enable --py jupyter-openbis-extension --user
+```
+
+If you want to install the extension globally, use `--system` instead of `--user`.
+
 ## Launching Jupyter notebook
 
 Now you are ready to launch Jupyter notebook:
@@ -122,4 +134,4 @@ The `-e` is a shortcut for `--editable`. This means, it will only establish a li
 
 If you make modifications on the UI (the Javascript files) you only need to reload the page in order the see the effect.
 
-How to extend Jupyter Notebooks is described [here](https://jupyter-notebook.readthedocs.io/en/stable/extending/index.html). To distribute Jupyter Extensions, read this [documentation](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Distributing%20Jupyter%20Extensions%20as%20Python%20Packages.html#) carefully.
+How to extend Jupyter Notebooks is described [here](https://jupyter-notebook.readthedocs.io/en/stable/extending/index.html). To distribute Jupyter Extensions, read this [documentation](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Distributing%20Jupyter%20Extensions%20as%20Python%20Packages.html#) carefully.
\ No newline at end of file

README.rst

@@ -69,6 +69,23 @@ These directories can be found by invoking
 The ``config`` section from the output lists the directories where your
 ``openbis-connections.yaml`` file should be placed.
 
+install Jupyter extension manually
+----------------------------------
+
+In most cases, a simple
+``pip install --upgrade jupyter-openbis-extension`` will do. However, in
+some cases you need to issue the following commands to get the extension
+running correctly:
+
+::
+
+    $ jupyter serverextension enable --py jupyter-openbis-extension
+    $ jupyter nbextension install --py jupyter-openbis-extension --user
+    $ jupyter nbextension enable --py jupyter-openbis-extension --user
+
+If you want to install the extension globally, use ``--system`` instead
+of ``--user``.
+
 Launching Jupyter notebook
 --------------------------
 
@@ -131,9 +148,15 @@ steps:
 After the setup is complete, you'll have
 
 -  Jupyter with openBIS extension running at http://localhost:8888.
--  openBIS running at http://localhost:8122, with credentials
+-  openBIS running at https://localhost:8122/openbis/, with credentials
    admin/password.
--  Experiment /DEFAULT/DEFAULT with a lot of datasets for testing.
+-  Object /DEFAULT/DEFAULT with a lot of datasets for testing.
+
+Hint: Jupyter creates no log file. Everything is printed onto the
+console. In order to see this output do the following: 1. vagrant ssh 2.
+screen -r
+
+You can escape from the screen by typing ^A followed by ^D.
 
 clone repository and install extension for development
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

jupyter-openbis-extension/__init__.py

 name = 'jupyter-openbis-extension.server'
 __author__ = 'Swen Vermeul'
 __email__ = 'swen@ethz.ch'
-__version__ = '0.2.2'
+__version__ = '0.2.3'
 
 def _jupyter_server_extension_paths():
     return [{

setup.py

@@ -11,7 +11,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name='jupyter-openbis-extension',
-    version= '0.2.2',
+    version= '0.2.3',
     author='Swen Vermeul |  ID SIS | ETH Zürich',
     author_email='swen@ethz.ch',
     description='Extension for Jupyter notebooks to connect to openBIS and download/upload datasets, inluding the notebook itself',