{% extends "base.html" %} {% block main %}

Getting started

Sketching.py offers multiple pathways depending on where you want to start coding first. Want to learn a little bit more about Sketching before you start programming? Check out our why sketching page.

Web

For the easiest place to get started, we have an online editor where you can build your sketchbook without installing any software. All you need is a browser! Note that Sketching running on the web installs as a pure-Python wheel so no additional dependencies like numpy are needed. Two sketches to get you started: Looking for more inspiration? Check out the examples. Once you've tried your first bits of code, learn how to deploy your sketches or embed them in larger web pages. Need some help or maybe you found a bug? Check out the community section for links to chat rooms, bug tracker, and more. Note that the web version uses the Sketch2DWeb renderer which is built on top of WebAssembly and PyScript.

Desktop

You can use Sketching.py locally on your own machine like a laptop or desktop using plain old Python programs in ".py" files. The bare minimum install:
pip install pillow sketching
Try making a simple image in this static renderer example. If you want to make interactive or animated sketches:
pip install pillow pygame sketching
After pip is done, try an interactive example or explore how to make stand-alone executables. The larger examples section may be a good next stop as well. Run into some trouble? Visit the community page for our Discord, issue tracker, and more. Note that this type of desktop usage for Sketching.py uses the Sketch2D renderer and Sketch2DStatic renderer built on top of Pygame and Pillow.

Notebook

Want to jump right in? Check out our Binder! Anyway, Sketching enables users to pair the power of scientific programming with the expressiveness and flexibility of creative coding through Jupyter ecosystem integration. Get started by installing:
pip install matplotlib pillow sketching
Then, take a look at an example Jupyter Notebook. Learn more about what you can do with Sketching.py by reading through the examples. Need just a little more help? Visit the community tab to connect with other users, let developers know about problems, and more. Note that we currently recommend using the Sketch2DStatic renderer with Jupyter.

Mobile

More details on mobile coming soon. Until then, try taking a look at Sketching.py's web option which is also intended to work for mobile browsers.

Other (static)

You can run Sketching.py just about anywhere you can execute Python. This includes servers which don't have desktop environments. The minimum install:
pip install sketching pillow
This will enable use of the Sketch2DStatic renderer built on top of Pillow and it can be used in headless environments. Need more help getting started? See the examples. Stuck? Visit the community tab to chat online with other friendly users, let developers know about problems, and more.
{% endblock %}