Metadata-Version: 2.1
Name: janim
Version: 0.3.1
Summary: a library for simple animation effects
Author: jkjkil4
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: colour
Requires-Dist: rich
Requires-Dist: glm
Requires-Dist: moderngl
Requires-Dist: tqdm
Requires-Dist: psutil
Requires-Dist: skia-pathops
Requires-Dist: fontTools
Requires-Dist: freetype-py
Requires-Dist: pillow
Requires-Dist: svgelements
Requires-Dist: sphinx ; extra == "doc"
Requires-Dist: furo ; extra == "doc"
Requires-Dist: pyside6 ; extra == "gui"
Requires-Dist: qdarkstyle ; extra == "gui"
Project-URL: Documentation, https://janim.rtfd.io
Project-URL: Home, https://github.com/jkjkil4/JAnim
Project-URL: Source, https://github.com/jkjkil4/JAnim
Provides-Extra: doc
Provides-Extra: gui

![logo](logo.png)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)


## Introduction
JAnim is a library for simple animation effects.

Inspired by [manim](https://github.com/3b1b/manim).


## Installation
JAnim runs on Python 3.12+ and OpenGL 4.3+.

You may install JAnim directly via
```sh
pip install janim
```
to install the latest version distributed on pypi. Or, to catch up with the latest development and edit the source code, you may clone this repository via
```sh
git clone https://github.com/jkjkil4/JAnim.git
cd JAnim
pip install -e .
```

Additionally, there are other software dependencies to be installed:
- To generate video files, install [ffmpeg](https://ffmpeg.org/).
- To use `Typst`, install [typst](https://github.com/typst/typst).


## Using JAnim

You can run
```sh
janim examples
```
to see examples.


## License

MIT license

