jupyter / jupyter-js-utils Goto Github PK

View Code? Open in Web Editor NEW

6.0 7.0 4.0 223 KB

JavaScript utilities for the Jupyter frontend

License: BSD 3-Clause "New" or "Revised" License

Shell 1.59% TypeScript 97.61% JavaScript 0.81%

jupyter-js-utils's Introduction

jupyter-js-utils

JavaScript utilities for the Jupyter frontend.

API Docs

Package Install

Prerequisites

node

npm install --save jupyter-js-utils

Source Build

Prerequisites

git
node

git clone https://github.com/jupyter/jupyter-js-utils.git
cd jupyter-js-utils
npm install

Rebuild

npm run clean
npm run build

Run Tests

Follow the source build instructions first.

# run tests in Firefox
npm test

# run tests in Chrome
npm run test:chrome

# run tests in IE
npm run test:ie

Build Docs

Follow the source build instructions first.

npm run docs

Navigate to docs/index.html.

Supported Runtimes

The runtime versions which are currently known to work are listed below. Earlier versions may also work, but come with no guarantees.

Node 0.12.7+
IE 11+
Firefox 32+
Chrome 38+

Note: "requirejs" must be included in a global context for Comm targets.

Usage Examples

Note: This module is fully compatible with Node/Babel/ES6/ES5. Simply omit the type declarations when using a language other than TypeScript.

jupyter-js-utils's People

Contributors

Stargazers

Watchers

Forkers

blink1073 kfix simonbiggs npmcdn-to-unpkg-bot

jupyter-js-utils's Issues

Handle wss when there is a partial base url

e.g. baseUrl is '/user/foo` but the actual address is https.

Dynamic Requires

@jdfreder @jasongrout @sccolbert @minrk

I am in favor of the following:

For now, assume RequireJS is a global (script tag or global.requirejs = require('requirejs');). It has already caused problems as an import.
When WebPack 2.0 is released, use System.import('dynamic/' + moduleName).

Then, we can specify that dynamic/* uses an external loader in WebPack, and add a dynamic/ handler to the server. I believe this gives us the best interoperability with all loaders and environments.

Fix getWsUrl

Should only slice the baseUrl if it starts with http.

"At Unexpected token ." @ jupyter-js-services/lib/index.js:7:10

atom-notebook is failing when loading a notebook. Take a look: jupyter/atom-notebook#30

atom-notebook install failing at jupyter-js-utils

See this issue on atom-notebook: jupyter/atom-notebook#32 (comment)

npm ERR! Failed at the [email protected] postinstall script 'npm dedupe'.

Atom uses node v0.10.40 and npm v2.13.3 to install Node packages.

Any idea what may be causing this?

Add a Jupyter Config loader

Add a function that retrieves a config value from the HTML page via a handlebar template in a JSON script tag.

<script id="jupyter-config-data" type="application/json">
{org: 10, items:["one","two"]}
</script>

element = document.getElementById('jupyter-config-data);

JSON.parse throws error if response isn't valid json string

This line throws an error if you try connecting to a wrong url.

To reproduce this issue try connecting to https://tmp54.tmpnb.org/user/ which will return html rather than a valid json string. The full trackeback is:

SyntaxError: Unexpected token <
    at Object.parse (native)
    at [object Object].req.onload (/Users/lukasgeiger/code/hydrogen/node_modules/jupyter-js-services/node_modules/jupyter-js-utils/lib/index.js:166:33)
    at [object Object].dispatchEvent (/Users/lukasgeiger/code/hydrogen/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:591:25)
    at setState (/Users/lukasgeiger/code/hydrogen/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:614:14)
    at IncomingMessage.<anonymous> (/Users/lukasgeiger/code/hydrogen/node_modules/xmlhttprequest/lib/XMLHttpRequest.js:447:13)
    at emitNone (events.js:72:20)
    at IncomingMessage.emit (events.js:166:7)
    at endReadableNT (_stream_readable.js:905:12)
    at doNTCallback2 (node.js:465:9)
    at process._tickCallback (node.js:379:17)