Metadata-Version: 2.2
Name: ipysketch-lite
Version: 0.4.1
Summary: Simple sketching tool for Jupyter notebooks
Author-email: Matthew Taylor <matthew.taylor.andre@gmail.com>
License: Copyright (c) 2025 Matthew Andre Taylor
Project-URL: Homepage, https://github.com/MatthewAndreTaylor/ipysketch_lite
Keywords: jupyter,sketch,drawing,canvas
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pillow==10.2.0
Requires-Dist: anywidget
Requires-Dist: ipywidgets==8.1.2

# ipysketch_lite 🎨

[![PyPI](https://img.shields.io/pypi/v/ipysketch-lite.svg)](https://pypi.org/project/ipysketch-lite)
[![Docs](https://img.shields.io/badge/Docs-informational?logo=readthedocs&logoColor=white)](https://matthewandretaylor.github.io/ipysketch_lite)
[![Jupyterlite](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://matthewandretaylor.github.io/ipysketch_lite/jupyterlite/lab?path=lite_example.ipynb)


**ipysketch_lite** is a simple interactive sketching tool for Jupyter notebooks.
After drawing a sketch you can use it directly in your Jupyter notebook.
When changes are made to the sketch, the image data in Python is updated.


![demo](https://github.com/user-attachments/assets/32504e77-a9d1-43c2-96ff-dc0acff48393)

Try it out in JupyterLite: [![Jupyterlite](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://matthewandretaylor.github.io/ipysketch_lite/jupyterlite/lab?path=lite_example.ipynb)


## Documentation 📖

You can view the documentation at: https://matthewandretaylor.github.io/ipysketch_lite


## Install 🛠️

You can install using **pip**:

```bash
pip install ipysketch-lite
```

Or using **piplite** if you are using [Jupyter lite](https://matthewandretaylor.github.io/ipysketch_lite/jupyterlite/lab?path=lite_example.ipynb)

```py
import piplite
await piplite.install("ipysketch_lite")
```

## Quickstart 🚀

Start drawing a quick sketch in your notebook like this

```py
from ipysketch_lite import Sketch

sketch = Sketch()
```

Then add a new cell to retrieve the sketch data in python

```py
sketch.data # Sketch image data as a base64 encoded string
sketch.image # PIL Image of the sketch
```

![example sketch](https://github.com/MatthewAndreTaylor/ipysketch_lite/blob/main/docs/_static/example.png?raw=true)

Sketch data gets updated in cells after the sketch is modified.
This means you can edit your sketch and get the new updated outputs
