Creator Studio Document Format

A Python library for reading, creating, and editing Apple Creator Studio documents, starting with Keynote.

This library works with Keynote presentations in Keynote Interchange Format (.keyx). You can use it to:

  • Read the slides, text, images, tables, charts, styles, and more in a .keyx file exported from Keynote.

  • Create a presentation from scratch, or from a theme’s slide layouts and styles.

  • Edit a presentation, and check it against the format’s rules before you save it.

The library reads and writes .keyx files itself, so it doesn’t need Keynote, an Apple device, or a network connection. To preview a presentation, open it in Keynote on an Apple device. In other places, use the Creator Studio Document Exporting API to convert to other formats like PDF.

Guide

Follow the tasks, from creating your first presentation to validating and navigating a document.

Presentation content

Creating and editing a presentation

Install the library, create a presentation with one slide and open it in Keynote, then edit it.

Adding content to a slide

Add text, shapes, images, tables, and charts to a slide, and connect them with lines.

Authoring from a theme

Build a styled document from a theme’s slide layouts, and style new objects using its presets.

Validation and navigation

Validating a document

Check a document against the format’s rules as you open, edit, and save it, so that Keynote opens it as you wrote it.

Navigating a document efficiently

Find the model instances you need without reading the whole document.

Supporting material

Glossary

Look up the terms that the guide and the API use in a specific sense.

Keynote Interchange Format

Look up what each part of a document means in the format’s own documentation.

Creator Studio Document Exporting API

Convert a presentation to other formats like PDF.

License

Read the terms that cover the library, Apache License v2.0.

API reference

Look up every public symbol in the library, one page per topic.

Presentation

Build the presentation at a document’s root, and every model it contains.

Documents and their contents

Open and save a document, and manage the presets, manifest, and resources it stores beside its presentation.

Document authoring, navigation, and validation

Build, search, and check a document.

Model bases

Set union cases and override values through the base classes that every model derives from.