sketch-document-py 1.0.1

This project contains the APIs to work with Sketch documents and document elements in Python dataclass.

.sketch document for python

Sketch stores documents in .sketch format, a zipped archive of JSON formatted data and binary data such as images.

Inspired by sketch-hq/sketch-document

Sketch file format schemas and APIs.

This project contains the APIs to work with Sketch documents and document elements in Python dataclass.

• sketch-file-format-py: Python dataclass type hint to strongly type objects representing Sketch documents, or fragments of Sketch documents in TypeScript projects.
• sketch-file: Python APIs to read and write .sketch files.

Development

To build this project, you need install Python build dependency management tool Poetry, to install Poetry , follow Poetry installation guide

To install nessasary deps and CLI tools, including a task runner Poe the Poet(CLI executable named poe) that work with Poetry, run command:

poetry install

To generate Sketch Dataclass type file, which is nessasary for build or install development, run command:

poe gen_types

For further usages of Poetry, check Poetry Documentation For further usages of Poe the Poet, check Poe the Poet Homepage