add convert backends to give the user a choice of using their preferred tool

Author: FredHappyface

.gitignore

@@ -1,8 +1,8 @@
 downloads/
 env*
 requirements_optional.txt
+tests/data
 
-# DepHell stuff
 poetry.lock
 
 # Byte-compiled / optimized / DLL files

.pre-commit-config.yaml

@@ -1,44 +1,45 @@
 repos:
-  - repo: https://github.com/FHPythonUtils/Blackt
-    rev: '2022.0.3'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.3
     hooks:
-      - id: blackt
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
 
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.354
     hooks:
-      - id: isort
+    - id: pyright
 
-  - repo: https://github.com/pycqa/pylint
-    rev: v3.0.0a6
+  - repo: https://github.com/Lucas-C/pre-commit-hooks-safety
+    rev: v1.3.3
     hooks:
-      - id: pylint
-        exclude: "tests/"
-        args: [--disable=import-error,--jobs=0]
+    -   id: python-safety-dependencies-check
+        files: pyproject.toml
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
-        exclude: "tests/"
       - id: end-of-file-fixer
-        exclude: "tests/"
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-yaml
+      - id: detect-private-key
+      - id: mixed-line-ending
 
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.7.0
-    hooks:
-      - id: pyupgrade
-        args: [--py38-plus]
   - repo: https://github.com/boidolr/pre-commit-images
-    rev: v1.2.1
+    rev: v1.5.2
     hooks:
-      - id: optimize-avif
-        exclude: "tests/"
       - id: optimize-jpg
-        exclude: "tests/"
       - id: optimize-png
-        exclude: "tests/"
       - id: optimize-svg
-        exclude: "tests/"
       - id: optimize-webp
-        exclude: "tests/"
+
+exclude: "tests/data|documentation/reference"

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).
 
+## 2024 - 2024/03/17
+
+- add convert backends to give the user a choice of using their preferred tool
+- ruff
+- code quality improvements
+
 ## 2022.1.1 - 2022/06/25
 
 - Fix: add `parents=True` to `Path.mkdir()`

documentation/reference/README.md

@@ -8,4 +8,6 @@ A full list of `Tstickers` project modules.
     - [Module](tstickers/module.md#module)
     - [Caching](tstickers/caching.md#caching)
     - [Convert](tstickers/convert.md#convert)
+    - [Convert Pyrlottie](tstickers/convert_pyrlottie.md#convert-pyrlottie)
+    - [Convert Rlottie Python](tstickers/convert_rlottie_python.md#convert-rlottie-python)
     - [Downloader](tstickers/downloader.md#downloader)

documentation/reference/tstickers/caching.md

@@ -1,36 +1,59 @@
 # Caching
 
-[Tstickers Index](../README.md#tstickers-index) /
-[Tstickers](./index.md#tstickers) /
-Caching
+[Tstickers Index](../README.md#tstickers-index) / [Tstickers](./index.md#tstickers) / Caching
 
 > Auto-generated documentation for [tstickers.caching](../../../tstickers/caching.py) module.
 
 #### Attributes
 
-- `cachedSession` - requests_cache: `CachedSession('.cache/tstickers.requests.sqlite', backend='sqlite', expire_after=60 * 60 * 12, allowable_codes=(200), allowable_methods=('GET', 'POST'))`
+- `cachedSession` - requests_cache: CachedSession('.cache/tstickers.requests.sqlite', backend='sqlite', expire_after=60 * 60 * 12, allowable_codes=(200), allowable_methods=('GET', 'POST'))
 
 
 - [Caching](#caching)
+  - [_verifyConvertedV1](#_verifyconvertedv1)
   - [createConverted](#createconverted)
   - [verifyConverted](#verifyconverted)
 
+## _verifyConvertedV1
+
+[Show source in caching.py:47](../../../tstickers/caching.py#L47)
+
+Verify the cache for a packName using cache data.
+
+#### Arguments
+
+----
+ data (dict[str, Any]) packName cache data to verify
+
+#### Returns
+
+-------
+ - `bool` - if the converted cache has been verified
+
+#### Signature
+
+```python
+def _verifyConvertedV1(data: dict[str, Any]): ...
+```
+
+
+
 ## createConverted
 
-[Show source in caching.py:60](../../../tstickers/caching.py#L60)
+[Show source in caching.py:66](../../../tstickers/caching.py#L66)
 
-Write cache data to a file identified by packName
+Write cache data to a file identified by packName.
 
 #### Arguments
 
-- `packName` *str* - name of the sticker pack eg. "DonutTheDog"
-- `data` *dict* - packName cache data to write to cache
+----
+ - `packName` *str* - name of the sticker pack eg. "DonutTheDog"
+ - `data` *dict* - packName cache data to write to cache
 
 #### Signature
 
 ```python
-def createConverted(packName: str, data: dict):
-    ...
+def createConverted(packName: str, data: dict) -> None: ...
 ```
 
 
@@ -40,21 +63,20 @@ def createConverted(packName: str, data: dict):
 [Show source in caching.py:21](../../../tstickers/caching.py#L21)
 
 Verify the cache for a packName eg. "DonutTheDog". Uses the cache "version"
-to call the verify function for that version
+to call the verify function for that version.
 
 #### Arguments
 
-- `packName` *str* - name of the sticker pack eg. "DonutTheDog"
+----
+ - `packName` *str* - name of the sticker pack eg. "DonutTheDog"
 
 #### Returns
 
-- `bool` - if the converted cache has been verified
+-------
+ - `bool` - if the converted cache has been verified
 
 #### Signature
 
 ```python
-def verifyConverted(packName: str) -> bool:
-    ...
-```
-
-
+def verifyConverted(packName: str) -> bool: ...
+```

documentation/reference/tstickers/convert.md

@@ -1,112 +1,148 @@
 # Convert
 
-[Tstickers Index](../README.md#tstickers-index) /
-[Tstickers](./index.md#tstickers) /
-Convert
+[Tstickers Index](../README.md#tstickers-index) / [Tstickers](./index.md#tstickers) / Convert
 
 > Auto-generated documentation for [tstickers.convert](../../../tstickers/convert.py) module.
 
 - [Convert](#convert)
+  - [Backend](#backend)
   - [assureDirExists](#assuredirexists)
-  - [convertTgs](#converttgs)
-  - [convertWebp](#convertwebp)
+  - [convertAnimated](#convertanimated)
+  - [convertFunc](#convertfunc)
+  - [convertStatic](#convertstatic)
   - [convertWithPIL](#convertwithpil)
 
+## Backend
+
+[Show source in convert.py:15](../../../tstickers/convert.py#L15)
+
+#### Signature
+
+```python
+class Backend(IntEnum): ...
+```
+
+
+
 ## assureDirExists
 
-[Show source in convert.py:13](../../../tstickers/convert.py#L13)
+[Show source in convert.py:33](../../../tstickers/convert.py#L33)
 
-make the dir if not exists
+Make the dir if not exists.
 
 #### Arguments
 
-- `root` *Path* - the path of the root directory
-- `directory` *Path|str* - the directory name
+----
+ - `root` *Path* - the path of the root directory
+ - `directory` *Path|str* - the directory name
 
 #### Returns
 
-- `Path` - the full path
+-------
+ - `Path` - the full path
 
 #### Signature
 
 ```python
-def assureDirExists(root: Path, directory: Path | str) -> Path:
-    ...
+def assureDirExists(root: Path, directory: Path | str) -> Path: ...
 ```
 
 
 
-## convertTgs
+## convertAnimated
 
-[Show source in convert.py:72](../../../tstickers/convert.py#L72)
+[Show source in convert.py:101](../../../tstickers/convert.py#L101)
 
-Convert animated stickers to webp, gif and png
+Convert animated stickers to webp, gif and png.
 
 #### Arguments
 
-- `swd` *Path* - the sticker working directory (downloads/packName)
-- `threads` *int, optional* - number of threads to pass to ThreadPoolExecutor. Defaults to 4.
-- `frameSkip` *int, optional* - skip n number of frames in the interest of
-optimisation with a quality trade-off. Defaults to 1.
-- `scale` *float, optional* - upscale/ downscale the images produced. Intended
-for optimisation with a quality trade-off. Defaults to 1.
+----
+ - `swd` *Path* - the sticker working directory (downloads/packName)
+ - `threads` *int, optional* - number of threads to pass to ThreadPoolExecutor. Defaults to number of cores/ logical processors.
+ - `frameSkip` *int, optional* - skip n number of frames in the interest of
+ optimisation with a quality trade-off. Defaults to 1.
+ - `scale` *float, optional* - upscale/ downscale the images produced. Intended
+ for optimisation with a quality trade-off. Defaults to 1.
 
 #### Returns
 
-- `int` - number of stickers successfully converted
+-------
+ - `int` - number of stickers successfully converted
 
 #### Signature
 
 ```python
-def convertTgs(swd: Path, threads: int = 4, frameSkip: int = 1, scale: float = 1) -> int:
-    ...
+def convertAnimated(
+    swd: Path,
+    threads: int = multiprocessing.cpu_count(),
+    frameSkip: int = 1,
+    scale: float = 1,
+    backend: Backend = Backend.UNDEFINED,
+) -> int: ...
 ```
 
+#### See also
 
+- [Backend](#backend)
 
-## convertWebp
 
-[Show source in convert.py:44](../../../tstickers/convert.py#L44)
 
-Convert static stickers to png and gif
+## convertFunc
+
+[Show source in convert.py:21](../../../tstickers/convert.py#L21)
+
+#### Signature
+
+```python
+def convertFunc(_x, _y, _z, _a) -> int: ...
+```
+
+
+
+## convertStatic
+
+[Show source in convert.py:70](../../../tstickers/convert.py#L70)
+
+Convert static stickers to png and gif.
 
 #### Arguments
 
-- `swd` *Path* - the sticker working directory (downloads/packName)
-- `threads` *int, optional* - number of threads to pass to ThreadPoolExecutor. Defaults to 4.
+----
+ - `swd` *Path* - the sticker working directory (downloads/packName)
+ - `threads` *int, optional* - number of threads to pass to ThreadPoolExecutor. Defaults to 4.
 
 #### Returns
 
-- `int` - number of stickers successfully converted
+-------
+ - `int` - number of stickers successfully converted
 
 #### Signature
 
 ```python
-def convertWebp(swd: Path, threads: int = 4) -> int:
-    ...
+def convertStatic(swd: Path, threads: int = 4) -> int: ...
 ```
 
 
 
 ## convertWithPIL
 
-[Show source in convert.py:27](../../../tstickers/convert.py#L27)
+[Show source in convert.py:50](../../../tstickers/convert.py#L50)
 
-Convert the webp file to png
+Convert the webp file to png.
 
 #### Arguments
 
-- `inputFile` *str* - path to input file
+----
+ - `inputFile` *str* - path to input file
 
 #### Returns
 
-- `str` - path to input file
+-------
+ - `str` - path to input file
 
 #### Signature
 
 ```python
-def convertWithPIL(inputFile: str) -> str:
-    ...
-```
-
-
+def convertWithPIL(inputFile: str) -> str: ...
+```