Metadata-Version: 2.4
Name: zipzi
Version: 0.3.0a1
Summary: Typed Python client for the Zipzi authoring Runtime
License-Expression: MIT
License-File: LICENSE-MIT
License-File: THIRD_PARTY_NOTICES.md
Requires-Python: >=3.14, <3.15
Description-Content-Type: text/markdown

# Zipzi Python SDK

Build and animate [Zipzi 2D](https://github.com/getzipzi/zipzi-2d) models from
Python and collaborate with people or AI agents in the Zipzi Editor.

Requires **CPython 3.14**. Install the typed pure Python client:

```sh
python -m pip install --pre zipzi
```

Connect to a running Editor with `zipzi.connect()`. To use the in-process
Runtime with `zipzi.local()`, install the matching optional native backend:

```sh
python -m pip install --pre zipzi-native
```

`zipzi-native` installs its matching client as a dependency. Native wheels cover
macOS arm64 and Windows x86-64. The desktop Editor is available from
[GitHub Releases](https://github.com/getzipzi/zipzi-2d/releases).

## Read the installed documentation offline

The client includes a README, workflow guide, generated API reference and
executable recipe matching its installed version. Locate them without a network
connection, native backend or running Editor:

```python
from importlib.resources import files

package = files("zipzi")
print(package.joinpath("README.md").read_text(encoding="utf-8"))
print(package.joinpath("docs/getting-started.md"))
print(package.joinpath("docs/lifecycle.md"))
print(package.joinpath("docs/guide.md"))
print(package.joinpath("docs/reference/index.md"))
```

Follow the relative links in the installed README to read the guide and recipe.
Generated commands and query types are available in `zipzi.values`.
Read-only result shapes are in `zipzi.results`. Use
`print(zipzi.describe('Session.query').format())` for offline API help and
`snapshot.records(zipzi.values.Parameter)` for typed object payloads.

The Python client and native Runtime backend are MIT licensed. Editor services
run in the GPL-3.0-only Editor. See the
[project repository](https://github.com/getzipzi/zipzi-2d) for source, licensing
and contribution information.
