python-chamelboots

An example package. Generated with cookiecutter-pylibrary.


License
BSD-2-Clause
Install
pip install python-chamelboots==0.0.28

Documentation

Overview

Version v0.0.28.

This is a proof of concept package. It came out of my disdain for typing any sort of HTML tag.

I often code inside of Jupyter notebooks. Sometimes I want to display custom HTML inside of those notebooks.

The issue is that writing complex HTML such as a list by hand is tedious and error-prone. Template libraries do help, but they introduce their own clumsy syntax into HTML. And the templates are often very long strings that clutter the notebook. Storing the templates in files takes my mind away from the notebooks.

Then I discovered the template library Chameleon that uses valid HTML as its template. Brilliant!

Though I would still have to type the templates which are HTML tags which takes me back to my original disdain of typing HTML tags.

This library addresses that issue. It also adds some utilities that I use when coding inside notebooks.

Here is an example where I used chamelboots to insert a link menu into a notebook. The links were references to anchor tags inserted into a very long cell output. It made it easier to navigate the output. The navigation can even happen during code execution.

./readme_assets/anchors.gif

docs Documentation Status
tests
Travis-CI Build Status AppVeyor Build Status Requirements Status
Coverage Status
package

Generated with cookiecutter-pylibrary.

  • Free software: BSD 2-Clause License

Installation

pip install chamelboots

You can also install the in-development version with

pip install https://github.com/dm-wyncode/python-chamelboots/archive/master.zip

It is still possible to install by cloning this repository, activating a virtual environment, and running the following:

python setup.py install

Documentation

https://python-chamelboots.readthedocs.io/

Development

To run the all tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows
set PYTEST_ADDOPTS=--cov-append
tox
Other
PYTEST_ADDOPTS=--cov-append tox