Metadata-Version: 2.4
Name: parapara-anime
Version: 0.1.0
Summary: parapara-anime: This is a helper for creating a movie of a series of images.
Home-page: https://github.com/siruku6/parapara-anime
Download-URL: https://github.com/siruku6/parapara-anime
Author: siruku6
Author-email: sirukufarios@gmail.com
Maintainer: siruku6
Maintainer-email: sirukufarios@gmail.com
License: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Framework :: Matplotlib
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: IPython>=7.23.1
Requires-Dist: matplotlib>=3.0.0
Requires-Dist: numpy>=1.15
Requires-Dist: pyvirtualdisplay>=3.0
Requires-Dist: tqdm>=4.66.0
Provides-Extra: tutorial
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# parapara-anime

[![Lint and Pytest](https://github.com/siruku6/parapara-anime/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/siruku6/parapara-anime/actions/workflows/lint_and_test.yml)

This is a helper for creating a movie of a series of images... Like this!

<!-- The sample image for a behavior of this tool -->
<img src="docs/images/240630_parapara_anime_demo.gif" width="50%" alt="This image show how this tool works!">

## Install

- You can install this package by:
    ```bash
    $ pip install parapara-anime
    ```


## Dependency

- `Xvfb`  
The package `xvfb` is required to use this tool. So please install it like this.
    ```bash
    # Ubuntu
    $ apt -y install --no-install-recommends xvfb
    ```
    Otherwise, you will see the following error...
    ```python
    >>> import parapara
    Traceback (most recent call last):

    ...

    FileNotFoundError: [Errno 2] No such file or directory: 'Xvfb'
    ```


## Usage

- Please, refer to the sample codes in [these notebooks](/notebooks).


## Contributing

### How to contribute

1. Initialize your development environment by following [the instructions](/docs/DEV_ENVIRONMENT.md).
