# ipysketch_lite 🎨
[](https://pypi.org/project/ipysketch-lite)
[](https://matthewandretaylor.github.io/ipysketch_lite)
[](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.
Try it out in JupyterLite: [](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
```
Sketch data gets updated in cells after the sketch is modified.
This means you can edit your sketch and get the new updated outputs
Raw data
{
"_id": null,
"home_page": null,
"name": "ipysketch-lite",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jupyter, sketch, drawing, canvas",
"author": null,
"author_email": "Matthew Taylor <matthew.taylor.andre@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c7/8f/08c0996b84e90149a77c2e678620d26b26acdf2e52227e6a3986e12b6c6d/ipysketch_lite-0.4.2.tar.gz",
"platform": null,
"description": "# ipysketch_lite \ud83c\udfa8\n\n[](https://pypi.org/project/ipysketch-lite)\n[](https://matthewandretaylor.github.io/ipysketch_lite)\n[](https://matthewandretaylor.github.io/ipysketch_lite/jupyterlite/lab?path=lite_example.ipynb)\n\n\n**ipysketch_lite** is a simple interactive sketching tool for Jupyter notebooks.\nAfter drawing a sketch you can use it directly in your Jupyter notebook.\nWhen changes are made to the sketch, the image data in Python is updated.\n\n\n\n\nTry it out in JupyterLite: [](https://matthewandretaylor.github.io/ipysketch_lite/jupyterlite/lab?path=lite_example.ipynb)\n\n\n## Documentation \ud83d\udcd6\n\nYou can view the documentation at: https://matthewandretaylor.github.io/ipysketch_lite\n\n\n## Install \ud83d\udee0\ufe0f\n\nYou can install using **pip**:\n\n```bash\npip install ipysketch-lite\n```\n\nOr using **piplite** if you are using [Jupyter lite](https://matthewandretaylor.github.io/ipysketch_lite/jupyterlite/lab?path=lite_example.ipynb)\n\n```py\nimport piplite\nawait piplite.install(\"ipysketch_lite\")\n```\n\n## Quickstart \ud83d\ude80\n\nStart drawing a quick sketch in your notebook like this\n\n```py\nfrom ipysketch_lite import Sketch\n\nsketch = Sketch()\n```\n\nThen add a new cell to retrieve the sketch data in python\n\n```py\nsketch.data # Sketch image data as a base64 encoded string\nsketch.image # PIL Image of the sketch\n```\n\n\n\nSketch data gets updated in cells after the sketch is modified.\nThis means you can edit your sketch and get the new updated outputs\n",
"bugtrack_url": null,
"license": "Copyright (c) 2025 Matthew Andre Taylor",
"summary": "Simple sketching tool for Jupyter notebooks",
"version": "0.4.2",
"project_urls": {
"Homepage": "https://github.com/MatthewAndreTaylor/ipysketch_lite"
},
"split_keywords": [
"jupyter",
" sketch",
" drawing",
" canvas"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a950ee712b2502ec67558601ecf900058fdc2c3c64fe4f89e2ea30b05a3f461b",
"md5": "6b845ed3f432ee84f2f4207a174766d5",
"sha256": "e00a44cfb3e1578a6c5d06c899460d862ae607559900080a0ff1aa5e1355a9e5"
},
"downloads": -1,
"filename": "ipysketch_lite-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b845ed3f432ee84f2f4207a174766d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8029,
"upload_time": "2025-02-22T19:14:07",
"upload_time_iso_8601": "2025-02-22T19:14:07.426419Z",
"url": "https://files.pythonhosted.org/packages/a9/50/ee712b2502ec67558601ecf900058fdc2c3c64fe4f89e2ea30b05a3f461b/ipysketch_lite-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c78f08c0996b84e90149a77c2e678620d26b26acdf2e52227e6a3986e12b6c6d",
"md5": "3d05fb4446884ae79fd4c596dc21965e",
"sha256": "b23416ed084bd6c6caf53affb061906bcf204a03ab61f847d4097941bb7852c3"
},
"downloads": -1,
"filename": "ipysketch_lite-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "3d05fb4446884ae79fd4c596dc21965e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8076,
"upload_time": "2025-02-22T19:14:09",
"upload_time_iso_8601": "2025-02-22T19:14:09.357005Z",
"url": "https://files.pythonhosted.org/packages/c7/8f/08c0996b84e90149a77c2e678620d26b26acdf2e52227e6a3986e12b6c6d/ipysketch_lite-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-22 19:14:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MatthewAndreTaylor",
"github_project": "ipysketch_lite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ipysketch-lite"
}
JSON
