[](../../)
[](../../issues)
[](/LICENSE.md)
[](../../commits/master)
[](../../commits/master)
[](https://pypistats.org/packages/pylottie)
[](https://pepy.tech/project/pylottie)
[](https://pypi.org/project/pylottie)
<!-- omit in toc -->
# PyLottie
<img src="readme-assets/icons/name.png" alt="Project Icon" width="750">
Convert .tgs and .lottie to .webp or .gif using playwright.
## PyRlottie
If using one of the below environments, using PyRlottie can offer significant
speed and quality improvements over pylottie (between 1.5x and 5x in most cases)
Get it from:
- Pypi: https://pypi.org/project/pyrlottie
- Github: https://github.com/FHPythonUtils/PyRlottie
| Environment | Supported |
| ------------- | --------- |
| linux_x86_64 | ✔ |
| linux_aarch64 | ✔ |
| windows_amd64 | ✔ |
- [PyRlottie](#pyrlottie)
- [Formats](#formats)
- [Basic Usage](#basic-usage)
- [Documentation](#documentation)
- [Supported Environments (64bit)](#supported-environments-64bit)
- [Install With PIP](#install-with-pip)
- [Language information](#language-information)
- [Built for](#built-for)
- [Install Python on Windows](#install-python-on-windows)
- [Chocolatey](#chocolatey)
- [Windows - Python.org](#windows---pythonorg)
- [Install Python on Linux](#install-python-on-linux)
- [Apt](#apt)
- [Dnf](#dnf)
- [Install Python on MacOS](#install-python-on-macos)
- [Homebrew](#homebrew)
- [MacOS - Python.org](#macos---pythonorg)
- [How to run](#how-to-run)
- [Windows](#windows)
- [Linux/ MacOS](#linux-macos)
- [Building](#building)
- [Testing](#testing)
- [Download Project](#download-project)
- [Clone](#clone)
- [Using The Command Line](#using-the-command-line)
- [Using GitHub Desktop](#using-github-desktop)
- [Download Zip File](#download-zip-file)
- [Community Files](#community-files)
- [Licence](#licence)
- [Changelog](#changelog)
- [Code of Conduct](#code-of-conduct)
- [Contributing](#contributing)
- [Security](#security)
- [Support](#support)
- [Rationale](#rationale)
## Formats
convertLottie2ALL, convertMultLottie2ALL, convertLottie2GIF, convertMultLottie2GIF, convertLottie2WEBP, convertMultLottie2WEBP
| Format | Animated |
| ------ | -------- |
| .gif | ✔ |
| .webp | ✔ |
convertLotties2PIL
| Format | Animated |
| ------ | -------- |
| .gif | ✔ |
| .webp | ✔ |
| .apng | ✔ |
| .png | ❌ |
| .jpg | ❌ |
| etc... | ... |
https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html
## Basic Usage
Convert multiple tgs files to webp and gif
```py
inFiles = [f"test/file_43{idx}.tgs" for idx in range(7, 10)]
outFiles = [f"test/file_0_43{idx}" for idx in range(7, 10)]
pylottie.convertMultLottie2ALL(inFiles, outFiles)
```
## Documentation
A high-level overview of how the documentation is organized organized will help you know
where to look for certain things:
<!--
- [Tutorials](/documentation/tutorials) take you by the hand through a series of steps to get
started using the software. Start here if you’re new.
-->
- The [Technical Reference](/documentation/reference) documents APIs and other aspects of the
machinery. This documentation describes how to use the classes and functions at a lower level
and assume that you have a good high-level understanding of the software.
<!--
- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you
may have.
-->
## Supported Environments (64bit)
| Environment | Supported |
| ------------- | --------- |
| linux_x86_64 | ✔ |
| linux_aarch64 | ❌ |
| windows_amd64 | ✔ |
| darwin_x86_64 | ✔ |
| darwin_arm64 | ❌ |
For a full list of machine architecures for Linux see https://stackoverflow.com/questions/45125516/possible-values-for-uname-m
## Install With PIP
```python
pip install pylottie
```
Head to https://pypi.org/project/pylottie/ for more info
## Language information
### Built for
This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
3.11
## Install Python on Windows
### Chocolatey
```powershell
choco install python
```
### Windows - Python.org
To install Python, go to https://www.python.org/downloads/windows/ and download the latest
version.
## Install Python on Linux
### Apt
```bash
sudo apt install python3.x
```
### Dnf
```bash
sudo dnf install python3.x
```
## Install Python on MacOS
### Homebrew
```bash
brew install python@3.x
```
### MacOS - Python.org
To install Python, go to https://www.python.org/downloads/macos/ and download the latest
version.
## How to run
### Windows
- Module
`py -3.x -m [module]` or `[module]` (if module installs a script)
- File
`py -3.x [file]` or `./[file]`
### Linux/ MacOS
- Module
`python3.x -m [module]` or `[module]` (if module installs a script)
- File
`python3.x [file]` or `./[file]`
## Building
This project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This
command generates the documentation, updates the requirements.txt and builds the library artefacts
Note the functionality provided by fhmake can be approximated by the following
```sh
handsdown --cleanup -o documentation/reference
poetry export -f requirements.txt --output requirements.txt
poetry export -f requirements.txt --with dev --output requirements_optional.txt
poetry build
```
`fhmake audit` can be run to perform additional checks
## Testing
For testing with the version of python used by poetry use
```sh
poetry run pytest
```
Alternatively use `tox` to run tests over python 3.8 - 3.11
```sh
tox
```
## Download Project
### Clone
#### Using The Command Line
1. Press the Clone or download button in the top right
2. Copy the URL (link)
3. Open the command line and change directory to where you wish to
clone to
4. Type 'git clone' followed by URL in step 2
```bash
git clone https://github.com/FHPythonUtils/PyLottie
```
More information can be found at
https://help.github.com/en/articles/cloning-a-repository
#### Using GitHub Desktop
1. Press the Clone or download button in the top right
2. Click open in desktop
3. Choose the path for where you want and click Clone
More information can be found at
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
### Download Zip File
1. Download this GitHub repository
2. Extract the zip archive
3. Copy/ move to the desired location
## Community Files
### Licence
MIT License
Copyright (c) FredHappyface
(See the [LICENSE](/LICENSE.md) for more information.)
### Changelog
See the [Changelog](/CHANGELOG.md) for more information.
### Code of Conduct
Online communities include people from many backgrounds. The *Project*
contributors are committed to providing a friendly, safe and welcoming
environment for all. Please see the
[Code of Conduct](https://github.com/FHPythonUtils/.github/blob/master/CODE_OF_CONDUCT.md)
for more information.
### Contributing
Contributions are welcome, please see the
[Contributing Guidelines](https://github.com/FHPythonUtils/.github/blob/master/CONTRIBUTING.md)
for more information.
### Security
Thank you for improving the security of the project, please see the
[Security Policy](https://github.com/FHPythonUtils/.github/blob/master/SECURITY.md)
for more information.
### Support
Thank you for using this project, I hope it is of use to you. Please be aware that
those involved with the project often do so for fun along with other commitments
(such as work, family, etc). Please see the
[Support Policy](https://github.com/FHPythonUtils/.github/blob/master/SUPPORT.md)
for more information.
### Rationale
The rationale acts as a guide to various processes regarding projects such as
the versioning scheme and the programming styles used. Please see the
[Rationale](https://github.com/FHPythonUtils/.github/blob/master/RATIONALE.md)
for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/FHPythonUtils/PyLottie",
"name": "pylottie",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "FredHappyface",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/53/b2/b4881cc2f073c040e883d2d1f4217347ab253c99e0223b6307e6126adc6f/pylottie-2024.tar.gz",
"platform": null,
"description": "[](../../)\n[](../../issues)\n[](/LICENSE.md)\n[](../../commits/master)\n[](../../commits/master)\n[](https://pypistats.org/packages/pylottie)\n[](https://pepy.tech/project/pylottie)\n[](https://pypi.org/project/pylottie)\n\n<!-- omit in toc -->\n# PyLottie\n\n<img src=\"readme-assets/icons/name.png\" alt=\"Project Icon\" width=\"750\">\n\nConvert .tgs and .lottie to .webp or .gif using playwright.\n\n## PyRlottie\n\nIf using one of the below environments, using PyRlottie can offer significant\nspeed and quality improvements over pylottie (between 1.5x and 5x in most cases)\n\nGet it from:\n\n- Pypi: https://pypi.org/project/pyrlottie\n- Github: https://github.com/FHPythonUtils/PyRlottie\n\n| Environment | Supported |\n| ------------- | --------- |\n| linux_x86_64 | \u2714 |\n| linux_aarch64 | \u2714 |\n| windows_amd64 | \u2714 |\n\n- [PyRlottie](#pyrlottie)\n- [Formats](#formats)\n- [Basic Usage](#basic-usage)\n- [Documentation](#documentation)\n- [Supported Environments (64bit)](#supported-environments-64bit)\n- [Install With PIP](#install-with-pip)\n- [Language information](#language-information)\n\t- [Built for](#built-for)\n- [Install Python on Windows](#install-python-on-windows)\n\t- [Chocolatey](#chocolatey)\n\t- [Windows - Python.org](#windows---pythonorg)\n- [Install Python on Linux](#install-python-on-linux)\n\t- [Apt](#apt)\n\t- [Dnf](#dnf)\n- [Install Python on MacOS](#install-python-on-macos)\n\t- [Homebrew](#homebrew)\n\t- [MacOS - Python.org](#macos---pythonorg)\n- [How to run](#how-to-run)\n\t- [Windows](#windows)\n\t- [Linux/ MacOS](#linux-macos)\n- [Building](#building)\n- [Testing](#testing)\n- [Download Project](#download-project)\n\t- [Clone](#clone)\n\t\t- [Using The Command Line](#using-the-command-line)\n\t\t- [Using GitHub Desktop](#using-github-desktop)\n\t- [Download Zip File](#download-zip-file)\n- [Community Files](#community-files)\n\t- [Licence](#licence)\n\t- [Changelog](#changelog)\n\t- [Code of Conduct](#code-of-conduct)\n\t- [Contributing](#contributing)\n\t- [Security](#security)\n\t- [Support](#support)\n\t- [Rationale](#rationale)\n\n## Formats\n\nconvertLottie2ALL, convertMultLottie2ALL, convertLottie2GIF, convertMultLottie2GIF, convertLottie2WEBP, convertMultLottie2WEBP\n\n| Format | Animated |\n| ------ | -------- |\n| .gif | \u2714 |\n| .webp | \u2714 |\n\nconvertLotties2PIL\n\n| Format | Animated |\n| ------ | -------- |\n| .gif | \u2714 |\n| .webp | \u2714 |\n| .apng | \u2714 |\n| .png | \u274c |\n| .jpg | \u274c |\n| etc... | ... |\n\nhttps://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html\n\n## Basic Usage\n\nConvert multiple tgs files to webp and gif\n\n```py\ninFiles = [f\"test/file_43{idx}.tgs\" for idx in range(7, 10)]\noutFiles = [f\"test/file_0_43{idx}\" for idx in range(7, 10)]\n\npylottie.convertMultLottie2ALL(inFiles, outFiles)\n```\n\n## Documentation\n\nA high-level overview of how the documentation is organized organized will help you know\nwhere to look for certain things:\n\n<!--\n- [Tutorials](/documentation/tutorials) take you by the hand through a series of steps to get\n started using the software. Start here if you\u2019re new.\n-->\n- The [Technical Reference](/documentation/reference) documents APIs and other aspects of the\n machinery. This documentation describes how to use the classes and functions at a lower level\n and assume that you have a good high-level understanding of the software.\n<!--\n- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you\n may have.\n-->\n\n## Supported Environments (64bit)\n\n| Environment | Supported |\n| ------------- | --------- |\n| linux_x86_64 | \u2714 |\n| linux_aarch64 | \u274c |\n| windows_amd64 | \u2714 |\n| darwin_x86_64 | \u2714 |\n| darwin_arm64 | \u274c |\n\nFor a full list of machine architecures for Linux see https://stackoverflow.com/questions/45125516/possible-values-for-uname-m\n\n## Install With PIP\n\n```python\npip install pylottie\n```\n\nHead to https://pypi.org/project/pylottie/ for more info\n\n## Language information\n\n### Built for\n\nThis program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and\n3.11\n\n## Install Python on Windows\n\n### Chocolatey\n\n```powershell\nchoco install python\n```\n\n### Windows - Python.org\n\nTo install Python, go to https://www.python.org/downloads/windows/ and download the latest\nversion.\n\n## Install Python on Linux\n\n### Apt\n\n```bash\nsudo apt install python3.x\n```\n\n### Dnf\n\n```bash\nsudo dnf install python3.x\n```\n\n## Install Python on MacOS\n\n### Homebrew\n\n```bash\nbrew install python@3.x\n```\n\n### MacOS - Python.org\n\nTo install Python, go to https://www.python.org/downloads/macos/ and download the latest\nversion.\n\n## How to run\n\n### Windows\n\n- Module\n\t`py -3.x -m [module]` or `[module]` (if module installs a script)\n\n- File\n\t`py -3.x [file]` or `./[file]`\n\n### Linux/ MacOS\n\n- Module\n\t`python3.x -m [module]` or `[module]` (if module installs a script)\n\n- File\n\t`python3.x [file]` or `./[file]`\n\n## Building\n\nThis project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This\ncommand generates the documentation, updates the requirements.txt and builds the library artefacts\n\nNote the functionality provided by fhmake can be approximated by the following\n\n```sh\nhandsdown --cleanup -o documentation/reference\npoetry export -f requirements.txt --output requirements.txt\npoetry export -f requirements.txt --with dev --output requirements_optional.txt\npoetry build\n```\n\n`fhmake audit` can be run to perform additional checks\n\n## Testing\n\nFor testing with the version of python used by poetry use\n\n```sh\npoetry run pytest\n```\n\nAlternatively use `tox` to run tests over python 3.8 - 3.11\n\n```sh\ntox\n```\n\n## Download Project\n\n### Clone\n\n#### Using The Command Line\n\n1. Press the Clone or download button in the top right\n2. Copy the URL (link)\n3. Open the command line and change directory to where you wish to\nclone to\n4. Type 'git clone' followed by URL in step 2\n\t```bash\n\tgit clone https://github.com/FHPythonUtils/PyLottie\n\t```\n\nMore information can be found at\nhttps://help.github.com/en/articles/cloning-a-repository\n\n#### Using GitHub Desktop\n\n1. Press the Clone or download button in the top right\n2. Click open in desktop\n3. Choose the path for where you want and click Clone\n\nMore information can be found at\nhttps://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop\n\n### Download Zip File\n\n1. Download this GitHub repository\n2. Extract the zip archive\n3. Copy/ move to the desired location\n\n## Community Files\n\n### Licence\n\nMIT License\nCopyright (c) FredHappyface\n(See the [LICENSE](/LICENSE.md) for more information.)\n\n### Changelog\n\nSee the [Changelog](/CHANGELOG.md) for more information.\n\n### Code of Conduct\n\nOnline communities include people from many backgrounds. The *Project*\ncontributors are committed to providing a friendly, safe and welcoming\nenvironment for all. Please see the\n[Code of Conduct](https://github.com/FHPythonUtils/.github/blob/master/CODE_OF_CONDUCT.md)\n for more information.\n\n### Contributing\n\nContributions are welcome, please see the\n[Contributing Guidelines](https://github.com/FHPythonUtils/.github/blob/master/CONTRIBUTING.md)\nfor more information.\n\n### Security\n\nThank you for improving the security of the project, please see the\n[Security Policy](https://github.com/FHPythonUtils/.github/blob/master/SECURITY.md)\nfor more information.\n\n### Support\n\nThank you for using this project, I hope it is of use to you. Please be aware that\nthose involved with the project often do so for fun along with other commitments\n(such as work, family, etc). Please see the\n[Support Policy](https://github.com/FHPythonUtils/.github/blob/master/SUPPORT.md)\nfor more information.\n\n### Rationale\n\nThe rationale acts as a guide to various processes regarding projects such as\nthe versioning scheme and the programming styles used. Please see the\n[Rationale](https://github.com/FHPythonUtils/.github/blob/master/RATIONALE.md)\nfor more information.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Convert .tgs and .lottie to .webp or .gif using playwright.",
"version": "2024",
"project_urls": {
"Documentation": "https://github.com/FHPythonUtils/PyLottie/blob/master/README.md",
"Homepage": "https://github.com/FHPythonUtils/PyLottie",
"Repository": "https://github.com/FHPythonUtils/PyLottie"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "398ce5209b4b2a7c12a4878c736a825f16ca4d2623884c6621fa07024fc564da",
"md5": "e1027d0f65d7c73bf128402b00581e59",
"sha256": "bf637d129c596180d7340308027532a253c2222b64161cc0773885669e41d0e6"
},
"downloads": -1,
"filename": "pylottie-2024-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1027d0f65d7c73bf128402b00581e59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 73409,
"upload_time": "2024-03-30T20:47:08",
"upload_time_iso_8601": "2024-03-30T20:47:08.029264Z",
"url": "https://files.pythonhosted.org/packages/39/8c/e5209b4b2a7c12a4878c736a825f16ca4d2623884c6621fa07024fc564da/pylottie-2024-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53b2b4881cc2f073c040e883d2d1f4217347ab253c99e0223b6307e6126adc6f",
"md5": "0f7022cab89b1cb2e56a7ce59ff82bfc",
"sha256": "ce5794a474e9114ca976d3228acd596adf2ab440b8b9f8a6b5f49e6960e5b7e6"
},
"downloads": -1,
"filename": "pylottie-2024.tar.gz",
"has_sig": false,
"md5_digest": "0f7022cab89b1cb2e56a7ce59ff82bfc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 73120,
"upload_time": "2024-03-30T20:47:09",
"upload_time_iso_8601": "2024-03-30T20:47:09.806974Z",
"url": "https://files.pythonhosted.org/packages/53/b2/b4881cc2f073c040e883d2d1f4217347ab253c99e0223b6307e6126adc6f/pylottie-2024.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-30 20:47:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FHPythonUtils",
"github_project": "PyLottie",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Pillow",
"specs": [
[
">=",
"10.2.0"
],
[
"<",
"11"
]
]
},
{
"name": "install-playwright",
"specs": [
[
">=",
"0.0.1"
],
[
"<",
"2"
]
]
},
{
"name": "playwright",
"specs": [
[
">=",
"1.42.0"
],
[
"<",
"2"
]
]
}
],
"lcname": "pylottie"
}
JSON
