Skip to main content

Simple sketching tool for Jupyter notebooks

Project description

ipysketch_lite 🎨

PyPI Docs Jupyterlite

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

Try it out in JupyterLite: Jupyterlite

Documentation 📖

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

Install 🛠️

You can install using pip:

pip install ipysketch-lite

Or using piplite if you are using Jupyter lite

import piplite
await piplite.install("ipysketch_lite")

Quickstart 🚀

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 data in python

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

example sketch

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

Using your own drawing API 🖌️

You can extend ipysketch_lite to use your own JavaScript drawing library by subclassing Sketch and customizing the frontend template. See the custom_sketch.ipynb notebook for an example.


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.5.1.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ipysketch_lite-0.5.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file ipysketch_lite-0.5.1.tar.gz.

File metadata

  • Download URL: ipysketch_lite-0.5.1.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ipysketch_lite-0.5.1.tar.gz
Algorithm Hash digest
SHA256 21ff9e6c608fc10edc8380fcc639208c6e8b6dfb2e9a02c3959f17ae30b2ddd3
MD5 d628871368a2450eb901ab0839271066
BLAKE2b-256 c5bb3aad1477bb78d739dacc38e0bd1715a611be9d9424205f5ab289f9cf01d9

See more details on using hashes here.

Provenance

The following attestation bundles were made for ipysketch_lite-0.5.1.tar.gz:

Publisher: python-publish.yml on MatthewAndreTaylor/ipysketch_lite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ipysketch_lite-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: ipysketch_lite-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ipysketch_lite-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4d98a0e287a7e8711abf885b79b4b1d85263c37546ebdef8a66c96cb43cd314e
MD5 9561a934cac7539b165c1fa7824460a2
BLAKE2b-256 ad0deabcbe64e833f00dd728f9dd52c2962d336d8cc2a0cb61b51b7f020ef7bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for ipysketch_lite-0.5.1-py3-none-any.whl:

Publisher: python-publish.yml on MatthewAndreTaylor/ipysketch_lite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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