ver 2025

Author: FredHappyface

CHANGELOG.md

@@ -3,9 +3,16 @@
 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).
 
+## 2025 - 2025/02/16
+
+- be opinionated and install `rlottie-python` by default/ regardless
+- set default backend to `rlottie-python` in the cli
+- add `--fmt` to the cli, where the user can select a list of formats to convert to (default is png
+  and webp formats)
+- replace `--frameskip` with `--fps` as this is more intuitive
+
 ## 2024.1.3 - 2024/08/26
 
-- be opinionated and install `pyrlottie` by default/ regardless
 - clearly notify user if backend is not installed
 
 ## 2024.1.2 - 2024/03/25

documentation/reference/tstickers/convert.md

@@ -27,7 +27,7 @@ class Backend(IntEnum): ...
 
 ## convertAnimated
 
-[Show source in convert.py:87](../../../tstickers/convert.py#L87)
+[Show source in convert.py:93](../../../tstickers/convert.py#L93)
 
 Convert animated stickers, over a number of threads, at a given framerate, scale and to a
 set of formats.
@@ -78,15 +78,15 @@ Convert animated stickers with (Base/Backend.UNDEFINED).
 
 ```python
 def convertAnimatedFunc(
-    _swd: Path, _threads: int, _fps: int, _scale: float, _formats
+    _swd: Path, _threads: int, _fps: int, _scale: float, _formats: set[str] | None
 ) -> int: ...
 ```
 
 
 
 ## convertStatic
 
-[Show source in convert.py:56](../../../tstickers/convert.py#L56)
+[Show source in convert.py:62](../../../tstickers/convert.py#L62)
 
 Convert static stickers to specified formats.
 
@@ -115,7 +115,7 @@ def convertStatic(
 
 ## convertWithPIL
 
-[Show source in convert.py:38](../../../tstickers/convert.py#L38)
+[Show source in convert.py:44](../../../tstickers/convert.py#L44)
 
 Convert a webp file to specified formats.
 

tstickers/cli.py

@@ -48,19 +48,21 @@ def cli() -> None:  # pragma: no cover
 		"--fps",
 		default=20,
 		type=int,
-		help="Set fps. default=20",
+		help="Set fps for converted animated stickers (this does not affect "
+		"static images). default=20",
 	)
 	parser.add_argument(
 		"--scale",
 		default=1,
 		type=float,
-		help="Set scale. default=1.0",
+		help="Set scale for converted animated stickers (this does not affect "
+		"static images). default=1.0",
 	)
 	parser.add_argument(
 		"-b",
 		"--backend",
 		choices={"rlottie_python", "pyrlottie"},
-		default="pyrlottie",
+		default="rlottie_python",
 		help="Specify the convert backend",
 	)
 	args = parser.parse_args()
@@ -105,7 +107,7 @@ def cli() -> None:  # pragma: no cover
 
 	formats = {fmt for sublist in (args.fmt or []) for fmt in sublist}
 	if len(formats) == 0:
-		formats = allowed_formats
+		formats = {"png", "webp"}
 
 	downloader = StickerManager(token)
 	for pack in packs:

tstickers/convert.py

@@ -21,7 +21,13 @@ class Backend(IntEnum):
 	RLOTTIE_PYTHON = auto()
 
 
-def convertAnimatedFunc(_swd: Path, _threads: int, _fps: int, _scale: float, _formats) -> int:
+def convertAnimatedFunc(
+	_swd: Path,
+	_threads: int,
+	_fps: int,
+	_scale: float,
+	_formats: set[str] | None,
+) -> int:
 	"""Convert animated stickers with (Base/Backend.UNDEFINED)."""
 	msg = "Backend could not be loaded"
 	raise RuntimeError(msg)

tstickers/convert_rlottie_python.py

@@ -47,8 +47,8 @@ def convert_single_tgs(
 		width = int(width * scale)
 		height = int(height * scale)
 
-		for format in formats:
-			anim.save_animation(tgs_file.replace("tgs", format), fps, width=width, height=height)
+		for fmt in formats:
+			anim.save_animation(tgs_file.replace("tgs", fmt), fps, width=width, height=height)
 
 	finally:
 		anim.lottie_animation_destroy()