Giter VIP home page Giter VIP logo

ipysketch's Introduction

ipysketch

PyPI version

A Python package for handwriting and sketching in Jupyter notebooks.

Usage

A movie is worth a thousand pictures is worth a million words...

Sketch Demo

Where are my sketches saved?

When creating a Sketch instance, you give it a name, say mysketch. The sketch is then saved in the same folder as the Jupyter notebook in two files with ending .isk and .png. The first file is the ipysketch-internal file format, the second is a PNG-representation of it, which is also displayed in the notebook.

Using ipysketch without Jupyter

The ipysketch GUI can also be used outside of Jupyter notebooks. To create a sketch named mysketch enter:

python -m ipysketch mysketch

Installation

First, install the ipysketch package using pip:

pip install --upgrade ipysketch

Then install and enable the widgets extension in Jupyter:

jupyter nbextension install --user --py widgetsnbextension
jupyter nbextension enable --py widgetsnbextension

Development

Set up development environment

First clone or fork the repository. Then install the package in development mode:

pip install -e .

Running the tests

python -m unittest discover test

Running test coverage

If not already installed:

pip install coverage

Then

coverage run --source=ipysketch setup.py test
coverage report -m

Compatibility

ipysketch requires Python 3.

ipysketch's People

Contributors

matthias-baer avatar maroba avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.