Skip to main content

Simple sketching tool for Jupyter notebooks

Project description

ipysketch_lite 🎨

PyPI Docs Jupyterlite Open In Colab

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.2.tar.gz (8.6 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.2-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipysketch_lite-0.5.2.tar.gz
  • Upload date:
  • Size: 8.6 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.2.tar.gz
Algorithm Hash digest
SHA256 61ca49aaeb947c9c2ed8fd1a5abe27c81058a4c5a62c7d15b37f5fef999d735a
MD5 e07ed72285ef8daec506e56663aa8051
BLAKE2b-256 3fc92ce343777a6363149cc7b7faa1ebfaaf4f522f7f0c9dbdf7074733fdf9d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ipysketch_lite-0.5.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: ipysketch_lite-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 8.9 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6dc69b9bc7e9082f4f740ad3cd17d23030338e320a7c466d23bea1a837c2cf30
MD5 405760a2ef81e2e4836f578ff58b7066
BLAKE2b-256 bfcfb3a8156582fe53d684d38d3e671406176ce50e5ad2eff4ec682049b2f7ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for ipysketch_lite-0.5.2-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