Compare commits

..

No commits in common. "master" and "v0.0.1" have entirely different histories.

10 changed files with 28 additions and 100 deletions

2
.gitignore vendored
View file

@ -161,5 +161,3 @@ ENV/
# mypy
.mypy_cache/
.DS_Store

View file

@ -1,3 +0,0 @@
recursive-include jupyterlab_templates/templates/ *
include README.md
include LICENSE

View file

@ -20,9 +20,6 @@ serverextension: install ## enable serverextension
labextension: install ## enable labextension
jupyter labextension install .
dist: ## dist to pypi
python3 setup.py sdist upload -r pypi
# docs: ## make documentation
# make -C ./docs html
@ -34,4 +31,4 @@ help:
print-%:
@echo '$*=$($*)'
.PHONY: clean install serverextension labextension test tests help docs dist
.PHONY: clean install serverextension labextension test tests help docs

View file

@ -1,23 +1,11 @@
# jupyterlab_iframe
Open a site in a widget, or add a set of "quicklinks".
[![PyPI](https://img.shields.io/pypi/l/jupyterlab_iframe.svg)](https://pypi.python.org/pypi/jupyterlab_iframe)
[![PyPI](https://img.shields.io/pypi/v/jupyterlab_iframe.svg)](https://pypi.python.org/pypi/jupyterlab_iframe)
[![npm](https://img.shields.io/npm/v/jupyterlab_iframe.svg)](https://www.npmjs.com/package/jupyterlab_iframe)
![](https://raw.githubusercontent.com/timkpaine/jupyterlab_iframe/master/docs/example1.gif)
## Install
```bash
pip install jupyterlab_iframe
jupyter labextension install jupyterlab_iframe
jupyter serverextension enable --py jupyterlab_iframe
```
## Adding quicklinks
install the server extension, and add the following to `jupyter_notebook_config.py`
```python3
c.JupyterLabIFrame.iframes = ['list', 'of', 'sites']
c.JupyterLabIFrame.welcome = 'a site'
```

BIN
jupyterlab_iframe/.DS_Store vendored Normal file

Binary file not shown.

View file

@ -1,15 +1,13 @@
import ujson
from notebook.base.handlers import IPythonHandler
from notebook.utils import url_path_join
class IFrameHandler(IPythonHandler):
def initialize(self, welcome=None, sites=None):
self.sites = sites
self.welcome = welcome
def initialize(self, iframes=None):
self.iframes = iframes
def get(self):
self.finish(ujson.dumps({'welcome': self.welcome or '', 'sites': self.sites}))
self.finish(ujson.dumps(self.iframes))
def load_jupyter_server_extension(nb_server_app):
@ -20,13 +18,8 @@ def load_jupyter_server_extension(nb_server_app):
nb_server_app (NotebookWebApplication): handle to the Notebook webserver instance.
"""
web_app = nb_server_app.web_app
sites = nb_server_app.config.get('JupyterLabIFrame', {}).get('iframes', [])
welcome = nb_server_app.config.get('JupyterLabIFrame', {}).get('welcome', [])
iframes = nb_server_app.config.get('JupyterLabIFrame', {}).get('iframes', [])
host_pattern = '.*$'
base_url = web_app.settings['base_url']
print('Installing jupyterlab_iframe handler on path %s' % url_path_join(base_url, 'iframes'))
print('Handling iframes: %s' % sites)
web_app.add_handlers(host_pattern, [(url_path_join(base_url, 'iframes'), IFrameHandler, {'welcome': welcome, 'sites': sites})])
print('Installing jupyterlab_iframe handler on path %s' % '/iframes')
print('Handinling iframes: %s' % iframes)
web_app.add_handlers(host_pattern, [('/iframes', IFrameHandler, {'iframes': iframes})])

View file

@ -1,6 +1,6 @@
{
"name": "jupyterlab_iframe",
"version": "0.1.4",
"version": "0.0.1",
"description": "A JupyterLab extension.",
"author": "Tim Paine",
"main": "lib/index.js",
@ -21,10 +21,9 @@
"extension": true
},
"dependencies": {
"@jupyterlab/application": "^0.16.0",
"@jupyterlab/apputils": "^0.16.0",
"@jupyterlab/coreutils": "^1.0.2",
"@jupyterlab/docmanager": "^0.16.0",
"@jupyterlab/application": "^0.15.0",
"@jupyterlab/apputils": "^0.15.0",
"@jupyterlab/docmanager": "^0.15.0",
"@phosphor/disposable": "^1.1.2"
},
"devDependencies": {

View file

@ -1,6 +0,0 @@
[bdist_wheel]
universal=1
[metadata]
description_file = README.md
license_file = LICENSE

View file

@ -9,11 +9,11 @@ with open(path.join(here, 'README.md'), encoding='utf-8') as f:
setup(
name='jupyterlab_iframe',
version='0.0.8',
version='0.0.1',
description='IFrame widgets for JupyterLab',
long_description=long_description,
url='https://github.com/timkpaine/jupyterlab_iframe',
download_url='https://github.com/timkpaine/jupyterlab_iframe/archive/v0.0.8.tar.gz',
download_url='https://github.com/timkpaine/jupyterlab_iframe/archive/v0.0.1.tar.gz',
author='Tim Paine',
author_email='t.paine154@gmail.com',
license='GPL',
@ -29,7 +29,6 @@ setup(
keywords='jupyter jupyterlab',
packages=find_packages(exclude=['tests', ]),
data_files=[('', ["LICENSE", "README.md"])],
zip_safe=False,
# entry_points={

View file

@ -6,10 +6,6 @@ import {
ICommandPalette, showDialog, Dialog
} from '@jupyterlab/apputils';
import {
PageConfig
} from '@jupyterlab/coreutils'
import {
IDocumentManager
} from '@jupyterlab/docmanager';
@ -31,8 +27,6 @@ class IFrameWidget extends Widget {
constructor(path: string) {
super();
this.id = path;
this.title.label = path;
this.title.closable = true;
let div = document.createElement('div');
div.classList.add('iframe-widget');
@ -54,7 +48,7 @@ class OpenIFrameWidget extends Widget {
let input = document.createElement('input');
input.value = '';
input.placeholder = 'http://path.to.site';
input.placeholder = 'http://tim.paine.nyc';
body.appendChild(existingLabel);
body.appendChild(input);
@ -71,23 +65,8 @@ class OpenIFrameWidget extends Widget {
}
}
function registerSite(app: JupyterLab, palette: ICommandPalette, site: string){
let command = 'iframe:open-' + site;
app.commands.addCommand(command, {
label: 'Open ' + site,
isEnabled: () => true,
execute: () => {
let widget = new IFrameWidget(site);
app.shell.addToMainArea(widget);
app.shell.activateById(widget.id);
}
});
palette.addItem({command: command, category: 'Sites'});
}
function activate(app: JupyterLab, docManager: IDocumentManager, palette: ICommandPalette, restorer: ILayoutRestorer) {
console.log('JupyterLab extension knowledgelab is activated!');
// Declare a widget variable
let widget: IFrameWidget;
@ -108,10 +87,6 @@ function activate(app: JupyterLab, docManager: IDocumentManager, palette: IComma
focusNodeSelector: 'input',
buttons: [Dialog.cancelButton(), Dialog.okButton({ label: 'GO' })]
}).then(result => {
if (result.button.label === 'CANCEL') {
return;
}
if (!result.value) {
return null;
}
@ -133,38 +108,25 @@ function activate(app: JupyterLab, docManager: IDocumentManager, palette: IComma
// grab sites from serverextension
var xhr = new XMLHttpRequest();
xhr.open("GET", PageConfig.getBaseUrl() + "iframes", true);
xhr.open("GET", "/iframes", true);
xhr.onload = function (e:any) {
if (xhr.readyState === 4) {
if (xhr.status === 200) {
let jsn = JSON.parse(xhr.responseText);
let welcome = jsn['welcome'];
let welcome_included = false;
let sites = jsn['sites'];
let sites = JSON.parse(xhr.responseText);
for(let site of sites){
console.log('adding quicklink for ' + site);
if (site == welcome){
welcome_included = true;
}
registerSite(app, palette, site);
}
if (!welcome_included) {
registerSite(app, palette, welcome);
}
if (welcome) {
app.restored.then(() => {
if(!localStorage.getItem('jupyterlab_iframe_welcome')) {
localStorage.setItem('jupyterlab_iframe_welcome', 'false');
app.commands.execute('iframe:open-' + welcome);
let command = 'iframe:open-' + site;
app.commands.addCommand(command, {
label: 'Open ' + site,
isEnabled: () => true,
execute: () => {
widget = new IFrameWidget(site);
app.shell.addToMainArea(widget);
app.shell.activateById(widget.id);
}
});
palette.addItem({command: command, category: 'Sites'});
}
} else {
console.error(xhr.statusText);
}
@ -178,4 +140,5 @@ function activate(app: JupyterLab, docManager: IDocumentManager, palette: IComma
console.log('JupyterLab extension jupyterlab_iframe is activated!');
};
export default extension;