Open in new tab

jupickhr#

docs

install

extend

demo

rtd-badge

pypi-badge
conda-badge

npm-badge

binder-badge
lite-badge

pikchr text-based diagrams for JupyterLab, etc.

features#

  • supports writing and rendering pikchr in:

    • pikchr fenced code blocks in .ipynb cells and .md documents

    • rich display for the text/x-pikchr MIME type

    • Open With… ⯈ Pikchr for .pikchr text documents

    • jupickhr.widget.Pikchr for live updating

  • generates:

    • portable img tags (with fixed up special entities and fonts)

      • these can be drag-and-dropped directly into other tools, like ipydrawio

    • inline SVG

  • light, dark and autodetected themes

install#

pip install jupikchr "jupyterlab>=3.4,<4"

or

mamba install -c conda-forge jupikchr "jupyterlab>=3.4,<4"

or

conda install -c conda-forge jupikchr "jupyterlab>=3.4,<4"

If you want to integrate with, or just hack on, jupikchr itself, try the development installation steps.

how it works#

  • in the browser

    • pikchr source and metadata is found:

      • in Markdown by jupyterlab-markup

      • in text/x-pikchr rich display outputs

      • in the Jupyter widget

    • a WebWorker is started which loads the pickchr C executable, compiled to WebAssembly

    • the resulting HTML is either displayed directly, or embedded inside a portable img tag

      • in the case of rich outputs, the text/html display type is also stored inside the output as a fallback, e.g. for nbconvert

history#

0.2.0#

  • removed dependency on jupyterlab 3

    • note: this doesn’t mean it will “just work” with JupyterLab 4

  • add basic syntax highlighting with @deathbeds/codemirror-pikchr

  • vendor pikchr.wasm from fossil 2.20

  • widget

    • rename dark to dark_mode

    • add css_class

  • document

    • add toolbar with buttons for fit and tag

  • mime

    • fallback text/html outputs get populated after rendering in the browser

    • metadata

      • rename dark to darkMode

      • add cssClass

0.1.0#

  • initial release

roadmap#

  • improve quality with tests

  • show in-Lab syntax reference

  • render in static nbconvert exports

  • render in static sphinx exports

  • provide a language server with completion

contributing#

PRs welcome! Help is needed on both the Python and TypeScript side to bring pickhr diagrams to more of the Jupyter ecosystem! See the roadmap for known tasks.

setup#

mamba env update --file .binder/environment.yml
source activate jupikchr

doit#

List all available tasks:

doit list

Hint

optionally pass --deps to see which files would trigger running

Get up to a working state with:

doit binder

Get ready for a release:

doit

Hint

doit by itself just runs every task

Code of Conduct#

We adhere to the Jupyter Code Of Conduct

open source#

BSD 3-Clause License

Copyright (c) 2022, jupikchr contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.