Metadata-Version: 2.1
Name: cutiepynb
Version: 1.0.0
Summary: Make your Jupyter notebooks pretty with custom colors and a table of contents.
Author-email: Elisa Márquez-Zavala <emarquez@lcg.unam.mx>
License: MIT License
Project-URL: Homepage, https://github.com/emarquezz/cutiepynb
Keywords: cutiepynb
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Provides-Extra: all
Requires-Dist: cutiepynb[extra]; extra == "all"
Provides-Extra: extra
Requires-Dist: pandas; extra == "extra"

# cutiepynb 💖

[![PyPI Version](https://img.shields.io/pypi/v/cutiepynb.svg)](https://pypi.python.org/pypi/cutiepynb)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/cutiepynb.svg)](https://anaconda.org/conda-forge/cutiepynb)
![Run Python Tests](https://github.com/emarquezz/cutiepynb/actions/workflows/python-tests.yml/badge.svg)
![macOS Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/macos.yml/badge.svg)
![Ubuntu Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/ubuntu.yml/badge.svg)
![Windows Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/windows.yml/badge.svg)

**Turn your Jupyter Notebooks into beautiful, colorful cutie ipynb with cutiepynb!**  
Dress them up with vibrant title colors and an auto-generated table of contents.

- **License:** [MIT License](LICENSE)
- **Documentation:** [cutiepynb Docs](https://emarquezz.github.io/cutiepynb)

## Features ✨

- 🎨 **Customizable title colors** for notebook headings.
- 📚 **Automatic table of contents generation**.
- 🔄 **Supports dynamic updates** to heading styles.
- 🌈 **Works seamlessly with various seaborn color palettes**.

## Installation

You can install `cutiepynb` via pip:

```bash
pip install cutiepynb
```

## Examples

To see cutiepynb in action, run the following script to process example notebooks:

```bash
python run_examples.py
```

## Visual Demo

### Before Applying cutiepynb 🥱

<div>

<img src="./docs/images/example_1.jpeg" alt="Before Example"  width="500" style="border:1px solid #000000"/>
</div>

### After Applying cutiepynb 🎀

<img src="./docs/images/example_2.jpeg" alt="After Example"  width="500"/>


