Skip to main content

Simple sketching tool for Jupyter notebooks

Project description

ipysketch_lite

A lite sketching utility for python notebooks, no sockets or extra dependencies 🎨

(no extra widget code)

Make sketches right in your notebook then use the sketch in your python code.

Try yourself:

jupyterlite badge

PyPI Docs

Quickstart

To get started pip install the extension from PyPI

This can be done using pip for jupyter environments

pip install ipysketch-lite

Or using piplite if you are using jupyter lite

import piplite
await piplite.install("ipysketch_lite[extra]") # install the package and optionally pillow and numpy for the extra features

Start drawing a quick sketch in your notebook like this

from ipysketch_lite import Sketch

sketch = Sketch()

Then add a new cell to retrieve the sketch in python

sketch.data # Sketch image data as a base64 encoded string
import matplotlib.pyplot as plt

# Plot the sketch image or do image manipulation
plt.imshow(sketch.image)
plt.show()

example sketch

Sketches get updated in cells after draw updates

This means you can continue your sketch and get the new updated outputs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipysketch_lite-0.2.8.tar.gz (372.3 kB view hashes)

Uploaded Source

Built Distribution

ipysketch_lite-0.2.8-py3-none-any.whl (15.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page