Metadata-Version: 2.4
Name: keyed
Version: 0.1.0
Summary: A reactive animation library.
Author-email: Doug Mercer <dougmerceryt@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2024, Doug Mercer
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Keywords: keyed,animation,reactive
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: <3.13,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyav
Requires-Dist: pillow
Requires-Dist: pycairo
Requires-Dist: pydantic
Requires-Dist: pygments
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: signified
Requires-Dist: tqdm
Requires-Dist: typer
Provides-Extra: lint
Requires-Dist: ruff; extra == "lint"
Requires-Dist: pyright; extra == "lint"
Provides-Extra: test
Requires-Dist: hypothesis; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: syrupy; extra == "test"
Provides-Extra: docs
Requires-Dist: beautifulsoup4; extra == "docs"
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Requires-Dist: mkdocs-material-extensions; extra == "docs"
Provides-Extra: previewer
Requires-Dist: pyside6; extra == "previewer"
Requires-Dist: watchdog; extra == "previewer"
Provides-Extra: gpu-compositor
Requires-Dist: taichi; extra == "gpu-compositor"
Provides-Extra: all
Requires-Dist: keyed[docs,gpu-compositor,lint,previewer,test]; extra == "all"
Dynamic: license-file

# Keyed

[![PyPI - Downloads](https://img.shields.io/pypi/dw/keyed)](https://pypi.org/project/keyed/)
[![PyPI - Version](https://img.shields.io/pypi/v/keyed)](https://pypi.org/project/keyed/)
[![Tests Status](https://github.com/dougmercer/keyed/actions/workflows/tests.yml/badge.svg)](https://github.com/dougmercer/keyed/actions/workflows/tests.yml?query=branch%3Amain)

---

**Documentation**: [https://dougmercer.github.io/keyed](https://dougmercer.github.io/keyed)  
**Source Code**: [https://github.com/dougmercer/keyed](https://github.com/dougmercer/keyed)

---

Keyed is a Python library for creating programmatically defined animations. Named after [key frames](https://en.wikipedia.org/wiki/Key_frame), the defining points in an animation sequence, Keyed makes it easy to create sophisticated animations through code.

## Features

- **Reactive Programming Model**: Built using the reactive programming library [signified](https://github.com/dougmercer/signified) to make declaratively defining highly dynamic animations a breeze
- **Vector Graphics**: [Cairo](https://www.cairographics.org)-based rendering for crisp, scalable graphics
- **Flexible Shape System**: Define basic lines, shapes, curves, and complex geometries
- **Code Animation**: Animate syntax highled code snippets

## Installation

Keyed requires a couple system level dependencies (e.g., [Cairo](https://www.cairographics.org/download/) and [ffmpeg](https://www.ffmpeg.org/)).

For detailed installation instructions visit our [Installation Guide](https://dougmercer.github.io/keyed/install)
.

But, once you have the necessary system dependencies installed, installing `keyed` is as simple as,

```console
pip install keyed
```

## Project Status

This project is in beta, so APIs may change.

## Alternatives
While I find `keyed` very fun and useful (particularly for animating syntax highlighted code in my [YouTube videos](https://youtube.com/@dougmercer)), there are several other excellent and far more mature animation libraries that you should probably use instead.

Before you decide to use `keyed`, be sure to check out:

* [Manim](https://manim.community): Comprehensive mathematical animation system originally created by Grant Sanderson of the YouTube channel 3blue1brown, but later adopted and extended by the manim community.
* [py5](https://py5coding.org): A Python wrapper for p5, the Java animation library.
