Skip to main content

Tldraw for Jupyter

Project description

Jupyter Tldraw

PyPI version image

Installation:

python3.11 -m venv .venv
pip install jupyterlab
pip install tldraw
jupyterlab   (or alternative VS Code Jupyter Lab)

Example

from tldraw import TldrawWidget
t = TldrawWidget()
t

MakeReal Example

from tldraw import MakeReal
from api_key import api_key

m = MakeReal(width=1002, height = 500, api_key = api_key)
m

INFO: To use GPT4-Vision, you need an API key.

How do I get my API key?

  1. Create an OpenAI account at OpenAI
  2. In your Openai API account, navigate to Settings > Billing
  3. Click Add to credit balance
  4. Add at least $5 to your account
  5. Navigate to API Keys
  6. Click Create new secret key
  7. Copy the key to your clipboard.
  8. Back on your jupyter-tldraw folder, paste the key into the API key into a new file called api_key.py
  9. Add the key in this form: api_key = "sk-*************************".
  10. Add api_key.py into your gitignore. WARNING: Don't upload your API KEY on GitHub!

Now you're ready to run!

For transparency, this is how the key is used:
https://github.com/kolibril13/jupyter-tldraw/blob/main/src/tldraw/prompt.py#L5-L47

Changelog

2.0.6

Tweak prompt parameter.

2.0.5

Add requests module Tweak readme

2.0.4

Add experimental SVG/PNG export.
Add experimental .txt export.
Add makereal

2.0.3

Update to version 2.0.0-alpha.19

2.0.2

Add experimental TldrawImageArray

2.0.1

Switch to new version: @tldraw/tldraw@2.0.0-canary.b9d82466295e (Version from 6th November2023)

2.0.0

  • simplify to minimal template

1.0.0

  • Rename notebooks, and prepare 2.0.0 release.

0.1.5

  • add .venv to gitignore, so that it's not uploaded to pypi by hatch build.

0.1.4

  • Add experimental TldrawSegmentation

0.1.3

  • format toml

0.1.2

  • replace ipyreact backend with anywidget backend.
    • this will make this package more reliable, because all js and css is shipped via pip and not anymore via cdn.
  • Remove JupyterLite build.
  • Remove experimental files.

0.1.1

  • add update_plot in TldrawMatplotlib

0.1.0

  • Added TldrawMatplotlib

0.0.3

  • refactor readme
  • add jupyterlite demo

0.0.2

  • refactor code

0.0.1

  • init setup

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

tldraw-2.0.6.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

tldraw-2.0.6-py2.py3-none-any.whl (2.3 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file tldraw-2.0.6.tar.gz.

File metadata

  • Download URL: tldraw-2.0.6.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for tldraw-2.0.6.tar.gz
Algorithm Hash digest
SHA256 1267f0dcf14dd2dd70fe139306bb8ea1e448cdfdbcdded1fc1eec08b3766354e
MD5 b0af511bf9c29183d181039e8a7e38e6
BLAKE2b-256 b81c9fff8c913d244d2bbcd0ef4f528821ccca06679c7f4cf54a980586750956

See more details on using hashes here.

File details

Details for the file tldraw-2.0.6-py2.py3-none-any.whl.

File metadata

  • Download URL: tldraw-2.0.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for tldraw-2.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a16da8465b5af6a39aa072cb528af338bc0b1cd608a4066435da249182bc7170
MD5 2798712402e4ee5f52460651bf2942df
BLAKE2b-256 78c572a1307b1280f0e52e7bc7a8265cf01c4cc0bf46029b0f29f20739682735

See more details on using hashes here.

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