initial commit

Author: jhgoebbert

.github/workflows/build.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: build
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

CHANGELOG.md

@@ -1,6 +1,7 @@
 BSD 3-Clause License
 
-Copyright (c) 2023, Jens Henrik Goebbert
+Copyright (c) 2020, Forschungszentrum Juelich GmbH, Juelich Supercomputing Centre
+All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

LICENSE

@@ -0,0 +1,2 @@
+graft jupyter_nestdesktop_proxy/icons
+graft jupyter_nestdesktop_proxy/bin

MANIFEST.in

@@ -1,2 +1,61 @@
+![build](https://github.com/FZJ-JSC/jupyter-nestdesktop/workflows/build/badge.svg)
+
 # jupyter-nestdesktop-proxy
-Jupyter extensions for running a NEST Desktop proxy 
+Integrate NEST Desktop in your Jupyter environment for an fast, feature-rich and easy to use remote desktop in the browser.
+
+## Requirements
+- Python 3.6+
+- Jupyter Notebook 6.0+
+- JupyterLab >= 3.x
+- jupyter-server-proxy >= 3.1.0
+
+This package executes the `nest-desktop` command. This command assumes the `nest-desktop` command is available in the environment's $PATH.
+
+## Security
+Be aware, [NEST Desktop](https://nest-desktop.readthedocs.io) does not encrypt the communication and/or requires password to connect.  
+
+### NEST Desktop
+[NEST Desktop](https://nest-desktop.readthedocs.io) is a web-based GUI application for NEST Simulator, an advanced simulation tool for the computational neuroscience.
+
+### Jupyter-Server-Proxy
+[Jupyter-Server-Proxy](https://jupyter-server-proxy.readthedocs.io) lets you run arbitrary external processes (such as Xpra-HTML5) alongside your notebook, and provide authenticated web access to them.
+
+## Install 
+
+#### Create and Activate Environment
+```
+virtualenv -p python3 venv
+source venv/bin/activate
+```
+
+#### Install jupyter-nestdesktop-proxy
+```
+pip install git+https://github.com/FZJ-JSC/jupyter-nestdesktop-proxy.git
+```
+
+#### Enable jupyter-nestdesktop-proxy Extensions
+For Jupyter Classic, activate the jupyter-server-proxy extension:
+```
+jupyter serverextension enable --sys-prefix jupyter_server_proxy
+```
+
+For Jupyter Lab, install the @jupyterlab/server-proxy extension:
+```
+jupyter labextension install @jupyterlab/server-proxy
+jupyter lab build
+```
+
+#### Start Jupyter Classic or Jupyter Lab
+Click on the NEST Desktop icon from the JupyterLab Launcher or the NEST Desktop item from the New dropdown in Jupyter Classic.  
+Connect to your database as instructed in the Quickstart section.
+
+## Configuration
+This package calls `nest-desktop` with settings. Please read the [NEST Desktop](https://nest-desktop.readthedocs.io/en/latest/user/index.html) if you want to know the details.  
+You have to modify `setup_nestdesktop()` in `jupyter_nestdesktop_proxy/__init__.py` for change.
+
+## Credits
+- NEST Desktop
+- jupyter-server-proxy
+
+## License
+BSD 3-Clause

README.md

@@ -0,0 +1,13 @@
+# run: conda env create --file environment.yml
+name: jupyter-nestdesktop-proxy
+channels:
+  - conda-forge
+dependencies:
+  - jupyterlab=3
+  - jupyterlab_server
+  - jupyter-server-proxy>=3.1.0
+  - jupyter_conda
+  - pip
+  - pip:
+#      - nest-desktop>=3.2.0
+      - -r file:requirements.txt

conftest.py

@@ -0,0 +1,72 @@
+import os
+import logging
+
+logger = logging.getLogger(__name__)
+logger.setLevel('INFO')
+
+HERE = os.path.dirname(os.path.abspath(__file__))
+
+
+def get_nestdesktop_executable(prog):
+    from shutil import which
+
+    # Find prog in known locations
+    other_paths = [
+        os.path.join('/opt/nestdesktop/bin', prog),
+    ]
+
+    wp = os.path.join(HERE, 'bin', prog)
+    if os.path.exists(wp):
+        return wp
+
+    if which(prog):
+        return prog
+
+    for op in other_paths:
+        if os.path.exists(op):
+            return op
+
+    if os.getenv("NESTDESKTOP_BIN") is not None:
+        return os.getenv("NESTDESKTOP_BIN")
+
+    raise FileNotFoundError(f'Could not find {prog} in PATH')
+
+
+def _nestdesktop_mappath(path):
+
+    # always pass the url parameter
+    if path in ('/', '/index.html', ):
+        path = '/index.html' 
+
+    return path
+
+
+def setup_nestdesktop():
+    """ Setup commands and and return a dictionary compatible
+        with jupyter-server-proxy.
+    """
+
+    # launchers url file including url parameters
+    path_info = 'nestdesktop/index.html' + _nestdesktop_urlparams()
+
+    # create command
+    cmd = [
+        get_nestdesktop_executable('nest-desktop'),
+        '-h localhost',
+        '-p {port}',
+    ]
+    logger.info('NEST Desktop command: ' + ' '.join(cmd))
+
+    return {
+        'command': cmd,
+        'mappath': _nestdesktop_mappath,
+        'absolute_url': False,
+        'timeout': 90,
+        'new_browser_tab': True,
+        'launcher_entry': {
+            'enabled': True,
+            'icon_path': os.path.join(HERE, 'icons/nestdesktop-logo.svg'),
+            'title': 'NEST Desktop',
+            'path_info': path_info,
+        },
+    }

environment.yml

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# you might need to modify your environment
+# before you can start 'nest-desktop'
+# Do it here.
+
+# example:
+# module purge
+# module load Stages/2023
+# module load GCCcore/.11.3.0
+# module load nest-desktop/3.2.0
+
+nest-desktop "$@"