Skip to main content

Jupyter magic for managing linked JavaScript scripts and CSS styles.

Project description

jupyter-require

Jupyter magic library for managing linked JavaScript scripts and CSS styles.

About

The jupyter-require library is intended to be used in Jupyter notebooks.

jupyter-require allows you to link custom CSS and JavaScript files and even create and load your own styles and scripts directly from Jupyter notebook.


What is this for?

If you are into data visualization like me, you've most likely already heard of d3.js JavaScript ecosystem. It's incredibly powerful tool which can be used to create advanced interactive visualizations.

However, it is not very comfortable to use in Jupyter notebooks let alone integrate with Python (see the article about Custom D3.js Visualization in a Jupyter Notebook).

That's where jupyter-require and related jupyter-d3 come into play. jupyter-require allows you to source custom scripts (like d3) and styles and use them within the notebook with ease.

Check out also jupyter-d3 which takes the d3 workflow in Jupyter notebooks to another level.


Installation


pip install jupyter-require

Example usage

In Jupyter notebooks:

%load_ext jupyter_require

Loading libraries

Loading required libraries is now as simple as:

%require d3 https://d3js.org/d3.v5.min
%require d3-hierarchy https://d3js.org/d3-hierarchy.v1.min

Note that the path does NOT contain the .js file extension. This is requireJS standard.

The %require is jupyter magic command and the rest are the parameters. The command takes lib name and path.

Creating custom style elements

%%load_css

/* d3.css */


.links text {
    fill: none;
    stroke: #ccc;
    stroke-width: 1px;

}

.nodes {
    z-index: 1;
    font: 13px sans-serif;
}

.nodes circle {
    fill: darkslateblue;
    stroke: none;
}


Author: Marek Cermak macermak@redhat.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-require-0.1.7.tar.gz (7.7 kB view hashes)

Uploaded Source

Built Distribution

jupyter_require-0.1.7-py3-none-any.whl (10.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page