calc-note 0.3.0

Collection of utilities to ease the production of professional calculation notes using Python and Jupyter.

Calculation Note

calc_note is a collection of utilities to ease the production of professional calculation notes using Python and Jupyter.

Installation

Using pip:

pip install calc_note

Usage

Import calc_note with:

from calc_note.display import *

See tests/tests_calc_note.ipynb for usage examples.

show(pd.DataFrame)

Calling show() in a notebook on a DataFrame (instead of simply calling the DataFrame) prints a table that will remain pretty after the notebook's conversion to PDF.

md(str)

calc_notes imports the following:

from IPython.display import Markdown as md

The md(str) function can thus be used to generate Markdown content from a Python cell. The latter is useful to embed variables in Markdown tables, for example.

%%render Cell Magic

The %%render cell magic from handcalcs is include to render code blocks as LaTeX.

Contributing

Contributions are welcome. The package is managed with poetry starting from v0.3.0. A few useful commands are defined in Makefile.