release: 2023

Author: FredHappyface

.pre-commit-config.yaml

@@ -28,7 +28,7 @@ repos:
     rev: v3.3.1
     hooks:
       - id: pyupgrade
-        args: [--py37-plus]
+        args: [--py38-plus]
   - repo: https://github.com/boidolr/pre-commit-images
     rev: v1.1.0
     hooks:

CHANGELOG.md

@@ -3,6 +3,12 @@
 All major and minor version changes will be documented in this file. Details of
 patch-level version changes can be found in [commit messages](../../commits/master).
 
+## 2023 - 2023/01/08
+
+- Add tox config
+- Use `playwright` and `install_playwright` in-place of `pyppeteer`
+	- Seemingly minor perf improvements (~32s vs ~38s)
+
 ## 2022 - 2022/01/23
 
 - Improvements to saving gifs

README.md

@@ -8,7 +8,7 @@
 [![PyPI Total Downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&label=total%20downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fpylottie)](https://pepy.tech/project/pylottie)
 [![PyPI Version](https://img.shields.io/pypi/v/pylottie.svg?style=for-the-badge)](https://pypi.org/project/pylottie)
 
-<!-- omit in TOC -->
+<!-- omit in toc -->
 # PyLottie
 
 <img src="readme-assets/icons/name.png" alt="Project Icon" width="750">
@@ -51,6 +51,8 @@ Get it from:
 - [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)
@@ -139,8 +141,8 @@ Head to https://pypi.org/project/pylottie/ for more info
 
 ### Built for
 
-This program has been written for Python versions 3.7 - 3.10 and has been tested with both 3.7 and
-3.10
+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
 
@@ -200,6 +202,36 @@ version.
 - 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

documentation/reference/MODULES.md

@@ -1,8 +1,7 @@
-# Pylottie Modules
+# Pylottie Index
 
-> Auto-generated documentation modules index.
+> Auto-generated documentation index.
 
-Full list of [Pylottie](README.md#pylottie-index) project modules.
+A full list of `Pylottie` project modules.
 
-- [Pylottie Index](README.md#pylottie-index)
 - [Pylottie](pylottie/index.md#pylottie)

documentation/reference/README.md

@@ -1,27 +1,24 @@
 # Pylottie
 
-> Auto-generated documentation for [pylottie](../../../pylottie/__init__.py) module.
+[Pylottie Index](../README.md#pylottie-index) /
+Pylottie
 
-Support for animated stickers
+> Auto-generated documentation for [pylottie](../../../pylottie/__init__.py) module.
 
-- [Pylottie](../README.md#pylottie-index) / [Modules](../MODULES.md#pylottie-modules) / Pylottie
-    - [convertLottie2ALL](#convertlottie2all)
-    - [convertLottie2GIF](#convertlottie2gif)
-    - [convertLottie2Webp](#convertlottie2webp)
-    - [convertLotties2PIL](#convertlotties2pil)
-    - [convertMultLottie2ALL](#convertmultlottie2all)
-    - [convertMultLottie2GIF](#convertmultlottie2gif)
-    - [convertMultLottie2Webp](#convertmultlottie2webp)
-    - [recordLotties](#recordlotties)
-    - [recordSingleLottie](#recordsinglelottie)
+- [Pylottie](#pylottie)
+  - [convertLottie2ALL](#convertlottie2all)
+  - [convertLottie2GIF](#convertlottie2gif)
+  - [convertLottie2Webp](#convertlottie2webp)
+  - [convertLotties2PIL](#convertlotties2pil)
+  - [convertMultLottie2ALL](#convertmultlottie2all)
+  - [convertMultLottie2GIF](#convertmultlottie2gif)
+  - [convertMultLottie2Webp](#convertmultlottie2webp)
+  - [recordLotties](#recordlotties)
+  - [recordSingleLottie](#recordsinglelottie)
 
 ## convertLottie2ALL
 
-[[find in source code]](../../../pylottie/__init__.py#L19)
-
-```python
-def convertLottie2ALL(fileName: str, newFileName: str, quality: int = 1):
-```
+[Show source in __init__.py:19](../../../pylottie/__init__.py#L19)
 
 Convert to gif and webp
 
@@ -31,14 +28,19 @@ Convert to gif and webp
 - `newFileName` *str* - name of the file to write (omit file ext)
 - `quality` *int, optional* - Quality of the returned sequence. Defaults to 1.
 
-## convertLottie2GIF
-
-[[find in source code]](../../../pylottie/__init__.py#L30)
+#### Signature
 
 ```python
-def convertLottie2GIF(fileName: str, newFileName: str, quality: int = 1):
+def convertLottie2ALL(fileName: str, newFileName: str, quality: int = 1):
+    ...
 ```
 
+
+
+## convertLottie2GIF
+
+[Show source in __init__.py:30](../../../pylottie/__init__.py#L30)
+
 Convert to gif
 
 #### Arguments
@@ -47,14 +49,19 @@ Convert to gif
 - `newFileName` *str* - name of the file to write
 - `quality` *int, optional* - Quality of the returned sequence. Defaults to 1.
 
-## convertLottie2Webp
-
-[[find in source code]](../../../pylottie/__init__.py#L41)
+#### Signature
 
 ```python
-def convertLottie2Webp(fileName: str, newFileName: str, quality: int = 1):
+def convertLottie2GIF(fileName: str, newFileName: str, quality: int = 1):
+    ...
 ```
 
+
+
+## convertLottie2Webp
+
+[Show source in __init__.py:41](../../../pylottie/__init__.py#L41)
+
 Convert to webp
 
 #### Arguments
@@ -63,17 +70,19 @@ Convert to webp
 - `newFileName` *str* - name of the file to write
 - `quality` *int, optional* - Quality of the returned sequence. Defaults to 1.
 
-## convertLotties2PIL
-
-[[find in source code]](../../../pylottie/__init__.py#L137)
+#### Signature
 
 ```python
-def convertLotties2PIL(
-    fileNames: list[str],
-    quality: int = 1,
-) -> list[tuple[list[Image.Image], float]]:
+def convertLottie2Webp(fileName: str, newFileName: str, quality: int = 1):
+    ...
 ```
 
+
+
+## convertLotties2PIL
+
+[Show source in __init__.py:137](../../../pylottie/__init__.py#L137)
+
 Convert list of lottie files to a list of images with a duration.
 
 #### Arguments
@@ -85,18 +94,21 @@ Convert list of lottie files to a list of images with a duration.
 
 - `list[tuple[list[Image],` *float]]* - pil images to write to gif/ webp and duration
 
-## convertMultLottie2ALL
-
-[[find in source code]](../../../pylottie/__init__.py#L52)
+#### Signature
 
 ```python
-def convertMultLottie2ALL(
-    fileNames: list[str],
-    newFileNames: list[str],
-    quality: int = 1,
-):
+def convertLotties2PIL(
+    fileNames: list[str], quality: int = 1
+) -> list[tuple[list[Image.Image], float]]:
+    ...
 ```
 
+
+
+## convertMultLottie2ALL
+
+[Show source in __init__.py:52](../../../pylottie/__init__.py#L52)
+
 Convert to gif and webp
 
 #### Arguments
@@ -105,18 +117,21 @@ Convert to gif and webp
 - `newFileNames` *list[str]* - name of the files to write (omit file ext)
 - `quality` *int, optional* - Quality of the returned sequence. Defaults to 1.
 
-## convertMultLottie2GIF
-
-[[find in source code]](../../../pylottie/__init__.py#L84)
+#### Signature
 
 ```python
-def convertMultLottie2GIF(
-    fileNames: list[str],
-    newFileNames: list[str],
-    quality: int = 1,
+def convertMultLottie2ALL(
+    fileNames: list[str], newFileNames: list[str], quality: int = 1
 ):
+    ...
 ```
 
+
+
+## convertMultLottie2GIF
+
+[Show source in __init__.py:84](../../../pylottie/__init__.py#L84)
+
 Convert to gif
 
 #### Arguments
@@ -125,18 +140,21 @@ Convert to gif
 - `newFileNames` *list[str]* - name of the files to write
 - `quality` *int, optional* - Quality of the returned sequence. Defaults to 1.
 
-## convertMultLottie2Webp
-
-[[find in source code]](../../../pylottie/__init__.py#L108)
+#### Signature
 
 ```python
-def convertMultLottie2Webp(
-    fileNames: list[str],
-    newFileNames: list[str],
-    quality: int = 1,
+def convertMultLottie2GIF(
+    fileNames: list[str], newFileNames: list[str], quality: int = 1
 ):
+    ...
 ```
 
+
+
+## convertMultLottie2Webp
+
+[Show source in __init__.py:108](../../../pylottie/__init__.py#L108)
+
 Convert to webp
 
 #### Arguments
@@ -145,17 +163,21 @@ Convert to webp
 - `newFileNames` *list[str]* - name of the files to write
 - `quality` *int, optional* - Quality of the returned sequence. Defaults to 1.
 
-## recordLotties
-
-[[find in source code]](../../../pylottie/__init__.py#L178)
+#### Signature
 
 ```python
-async def recordLotties(
-    lottieData: list[str],
-    quality: int,
-) -> list[list[int]]:
+def convertMultLottie2Webp(
+    fileNames: list[str], newFileNames: list[str], quality: int = 1
+):
+    ...
 ```
 
+
+
+## recordLotties
+
+[Show source in __init__.py:177](../../../pylottie/__init__.py#L177)
+
 Record the lottie data to a set of images
 
 #### Arguments
@@ -167,15 +189,24 @@ Record the lottie data to a set of images
 
 - `list[list[int]]` - duration and number of frames
 
+#### Signature
+
+```python
+def recordLotties(lottieData: list[str], quality: int) -> list[list[int]]:
+    ...
+```
+
+
+
 ## recordSingleLottie
 
-[[find in source code]](../../../pylottie/__init__.py#L212)
+[Show source in __init__.py:206](../../../pylottie/__init__.py#L206)
+
+#### Signature
 
 ```python
-async def recordSingleLottie(
-    browser,
-    lottieDataInstance,
-    quality,
-    index,
-) -> list[int]:
+def recordSingleLottie(browser, lottieDataInstance, quality, index) -> list[int]:
+    ...
 ```
+
+