Open in new tab

jupickhr#

Binder docs

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 documents

    • jupickhr.widget.Pikchr for live updating

  • generates:

    • portable img tags (with fixed up special entities)

  • light, dark and autodected themes

install#

TBD: if you’re not reading this on PyPI, it might not work quite yet so you may need to follow the development installation steps.

pip install jupikchr

or

mamba install -c conda-forge jupikchr

or

conda install -c conda-forge jupikchr

roadmap#

  • [ ] get an intial release out

  • [ ] tests

  • [ ] CodeMirror mode

  • [ ] figure out a plan for nbconvert

  • [ ] figure out a plan for sphinx

  • [ ] language server

contributing#

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.