Metadata-Version: 2.1
Name: SVGVideoMaker
Version: 0.4.2
Summary: Creator of video from svg with cairosvg, ffmpeg
Home-page: https://github.com/evayann/SVGVideoMaker
Author: Yann Zavattero
Author-email: yann.zavattero@hotmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# SVGVideoMaker

## About

The aim of this project is to write easy animation from description of position.
To do that, we use svg structure. <br/>
You create shape like circle, point, polygon, rectangle... and add animation by key time (in second).

## Documentation 

You can have full documentation if you execute command : <br/>
> python -m sphinx -b /path/to/SVGVideoMaker/Documentation /path/to/SVGVideoMaker/Documentation/html

## Shapes 

Available shapes :

-   Circle
-   Rectangle
-   Polygon
-   Arc
-   Segment

You can also made group who contain shape.

## Available operation on shape

-   Translation
-   Inflation
-   Reshaping (for polygon)

## Debug your program

### Warnings
Terminal supported for image displaying : **Terminology**, **Kitty** and others terminal can display pseudo image if you have ***viu*** installed. For viu, you can see the git [here](https://github.com/atanunq/viu).

You can get all keyframe for an element with `display_animations()` method on svg element.
You can display a svg element in terminal with `display(svg_element)` and you can display specific frame of a SVGVideoMaker with `print_frame(nb_frame:int)` and the number of frame to display.

## Examples

See video in examples file.

### Polygon

Utilisation of polygon of this API.
![Misc Gif](SVGVideoMaker/examples/Polygon.gif)

### Ellipse

Utilisation of ellipse of this API.
![Voronoi Gif](SVGVideoMaker/examples/EllipseArc.gif)


