Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupyterlab/jupyter-renderers
Renderers and renderer extensions for JupyterLab
https://github.com/jupyterlab/jupyter-renderers
fasta geojson jupyterlab jupyterlab-extension katex plotly vega vega-lite
Last synced: 13 days ago
JSON representation
Renderers and renderer extensions for JupyterLab
- Host: GitHub
- URL: https://github.com/jupyterlab/jupyter-renderers
- Owner: jupyterlab
- License: bsd-3-clause
- Created: 2017-06-08T16:59:07.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-15T18:01:51.000Z (28 days ago)
- Last Synced: 2024-10-19T13:21:31.430Z (24 days ago)
- Topics: fasta, geojson, jupyterlab, jupyterlab-extension, katex, plotly, vega, vega-lite
- Language: HTML
- Homepage:
- Size: 6.15 MB
- Stars: 489
- Watchers: 29
- Forks: 77
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jupyterlab - fasta,geojson,katex,plotly,vega2 - Multiple package repo that consists of generic renderers for common file types and mime types as well as renderer extensions for JupyterLab. (Uncategorized / Uncategorized)
- awesome-jupyter-resources - GitHub - 29% open · ⏱️ 08.07.2022): (JupyterLab渲染器)
- best-of-jupyter - GitHub - 35% open · ⏱️ 24.06.2024): (JupyterLab Renderer)
README
# Jupyter Renderers
[](https://mybinder.org/v2/gh/jupyterlab/jupyter-renderers/master?urlpath=lab/tree/notebooks)
This is a
[monorepo](https://github.com/lerna/lerna#what-does-a-lerna-repo-look-like) that
consists of [JupyterLab](https://github.com/jupyterlab/jupyterlab) _mimerender extensions_ for common file and MIME types.
## Packages
| Name | Mime types | File extensions | Info |
| ------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| [fasta-extension](packages/fasta-extension) | `application/vnd.fasta.fasta` | `.fasta` | [](https://pypi.org/project/jupyterlab-fasta/) |
| [geojson-extension](packages/geojson-extension) | `application/geo+json` | `.geojson`, `.geo.json` | [](https://pypi.org/project/jupyterlab-geojson) |
| [katex-extension](packages/katex-extension) | N/A | N/A | [](https://pypi.org/project/jupyterlab-katex) |
| [mathjax2-extension](packages/mathjax2-extension) | N/A | N/A | [](https://pypi.org/project/jupyterlab-mathjax2) |
| [vega3-extension](packages/vega3-extension) | `application/vnd.vega.v3+json`, `application/vnd.vegalite.v2+json` | `.vg`, `.vl`, `.vg.json`, `.vl.json`, `.vega`, `.vegalite` | [](https://pypi.org/project/jupyterlab-vega3) |
## Looking for plotly-extension?
[@jupyterlab/plotly-extension](https://www.npmjs.com/package/@jupyterlab/plotly-extension) is being deprecated. Please use the Plotly-supported [jupyterlab-plotly](https://www.npmjs.com/package/jupyterlab-plotly). See the [plotly.py README](https://github.com/plotly/plotly.py#jupyterlab-support-python-35) for more info.
## Install
With JupyterLab 3.0 and above, it is possible to install the prebuilt extensions with `pip`:
```bash
pip install jupyterlab-fasta
pip install jupyterlab-geojson
pip install jupyterlab-katex
pip install jupyterlab-mathjax2
pip install jupyterlab-vega3
```
## Contributing
If you would like to contribute to the project, please read our [contributor documentation](https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md).
JupyterLab follows the official [Jupyter Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).
## Requirements
- Node.js >= 18 (see [Installing Node.js and jlpm](https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md#installing-nodejs-and-jlpm) in the JupyterLab docs)
### Install
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
git clone https://github.com/jupyterlab/jupyter-renderers.git
cd jupyter-renderers
# install the fasta extension
cd packages/fasta-extension
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild the extensions TypeScript source after making changes
jlpm run build
```
### Rebuilding extensions
After making changes to the source packages, the packages must be rebuilt:
```bash
# Rebuild all the extensions at once
jlpm run build
# To rebuilt a particular extension, for example the fasta extension
cd packages/fasta-extension
jlpm run build
```
You may also watch a particular extension directory for changes and automatically rebuild:
```bash
# In one terminal tab, watch the jupyter-fasta directory
cd packages/fasta-extension
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```
### Publishing packages
Build all Python packages:
```
rm -rf dist/*
jlpm build-py
twine upload dist/jupyterlab*
```
### Creating icons
To create a JupyterLab icon for a new MIME or file type, you can use the Sketch
file in this repo or [fork the file on
Figma](https://www.figma.com/file/c2TwOvxAAXCzDccrybQKapZK/icons?node-id=0%3A1)
and export your icon as an SVG. See the [GeoJSON icon](https://github.com/jupyterlab/jupyter-renderers/tree/master/packages/geojson-extension/style) for reference.