rel 2024.1

Author: FredHappyface

.gitignore

@@ -2,6 +2,8 @@ downloads/
 env*
 requirements_optional.txt
 tests/data
+sticker*.txt
+sorted
 
 poetry.lock
 

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.1 - 2024/03/22
+
+- Add '--file' arg for passing in a list of packs
+- Implement a custom `demojize` function similar to the `emoji.demojize` function.
+	However, returns a string of unique keywords in alphabetical order seperated by "_"
+
 ## 2024 - 2024/03/17
 
 - add convert backends to give the user a choice of using their preferred tool

documentation/reference/tstickers/downloader.md

@@ -14,10 +14,11 @@
     - [StickerDownloader().downloadSticker](#stickerdownloader()downloadsticker)
     - [StickerDownloader().getPack](#stickerdownloader()getpack)
     - [StickerDownloader().getSticker](#stickerdownloader()getsticker)
+  - [demojize](#demojize)
 
 ## Sticker
 
-[Show source in downloader.py:20](../../../tstickers/downloader.py#L20)
+[Show source in downloader.py:54](../../../tstickers/downloader.py#L54)
 
 Sticker instance attributes.
 
@@ -36,7 +37,7 @@ class Sticker:
 
 ### Sticker().emojiName
 
-[Show source in downloader.py:38](../../../tstickers/downloader.py#L38)
+[Show source in downloader.py:72](../../../tstickers/downloader.py#L72)
 
 Get the emoji as a string.
 
@@ -50,7 +51,7 @@ def emojiName(self) -> str: ...
 
 ## StickerDownloader
 
-[Show source in downloader.py:43](../../../tstickers/downloader.py#L43)
+[Show source in downloader.py:77](../../../tstickers/downloader.py#L77)
 
 The StickerDownloader sets up the api and makes requests.
 
@@ -68,7 +69,7 @@ class StickerDownloader:
 
 ### StickerDownloader().convertPack
 
-[Show source in downloader.py:205](../../../tstickers/downloader.py#L205)
+[Show source in downloader.py:239](../../../tstickers/downloader.py#L239)
 
 Convert the webp to gif and png; tgs to gif, webp (webp_animated) and png.
 
@@ -101,7 +102,7 @@ def convertPack(
 
 ### StickerDownloader().doAPIReq
 
-[Show source in downloader.py:64](../../../tstickers/downloader.py#L64)
+[Show source in downloader.py:98](../../../tstickers/downloader.py#L98)
 
 Use the telegram api.
 
@@ -129,7 +130,7 @@ def doAPIReq(self, function: str, params: dict[Any, Any]) -> dict[Any, Any] | No
 
 ### StickerDownloader().downloadPack
 
-[Show source in downloader.py:167](../../../tstickers/downloader.py#L167)
+[Show source in downloader.py:201](../../../tstickers/downloader.py#L201)
 
 Download a sticker pack.
 
@@ -151,7 +152,7 @@ def downloadPack(self, pack: dict[str, Any]) -> bool: ...
 
 ### StickerDownloader().downloadSticker
 
-[Show source in downloader.py:152](../../../tstickers/downloader.py#L152)
+[Show source in downloader.py:186](../../../tstickers/downloader.py#L186)
 
 Download a sticker from the server.
 
@@ -174,7 +175,7 @@ def downloadSticker(self, path: Path, link: str) -> int: ...
 
 ### StickerDownloader().getPack
 
-[Show source in downloader.py:118](../../../tstickers/downloader.py#L118)
+[Show source in downloader.py:152](../../../tstickers/downloader.py#L152)
 
 Get a list of File objects.
 
@@ -196,7 +197,7 @@ def getPack(self, packName: str) -> dict[str, Any] | None: ...
 
 ### StickerDownloader().getSticker
 
-[Show source in downloader.py:95](../../../tstickers/downloader.py#L95)
+[Show source in downloader.py:129](../../../tstickers/downloader.py#L129)
 
 Get sticker info from the server.
 
@@ -218,4 +219,29 @@ def getSticker(self, fileData: dict[Any, Any]) -> Sticker: ...
 
 #### See also
 
-- [Sticker](#sticker)
+- [Sticker](#sticker)
+
+
+
+## demojize
+
+[Show source in downloader.py:21](../../../tstickers/downloader.py#L21)
+
+Similar to the emoji.demojize function.
+
+However, returns a string of unique keywords in alphabetical order seperated by "_"
+
+#### Arguments
+
+- `emoji` *str* - emoji unicode char
+
+#### Returns
+
+Type: *str*
+returns a string of unique keywords in alphabetical order seperated by "_"
+
+#### Signature
+
+```python
+def demojize(emoji: str) -> str: ...
+```

move_webp_stickers.py

@@ -0,0 +1,21 @@
+import shutil
+from pathlib import Path
+
+source_dir = Path("./downloads")
+
+packnames = [
+	name.name for name in source_dir.iterdir() if name.is_dir()
+]
+
+for packname in packnames:
+	source_path = source_dir / packname / "webp"
+	dest_path = Path("./sorted") / packname
+
+
+	print(packname)
+
+	if not dest_path.exists():
+		dest_path.mkdir(parents=True)
+
+	for file_path in source_path.iterdir():
+		shutil.copy(file_path, dest_path)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tstickers"
-version = "2024"
+version = "2024.1"
 license = "mit"
 description = "Download sticker packs from Telegram"
 authors = ["FredHappyface"]

tstickers/cli.py

@@ -29,6 +29,11 @@ def cli() -> None:  # pragma: no cover
 		nargs="+",
 		help="Pass in a pack url inline",
 	)
+	parser.add_argument(
+		"-f",
+		"--file",
+		help="Path to file containing pack urls",
+	)
 	parser.add_argument(
 		"--frameskip",
 		default=1,
@@ -64,7 +69,14 @@ def cli() -> None:  # pragma: no cover
 			)
 			sysexit(1)
 	# Get the packs
-	packs = functools.reduce(operator.iadd, args.pack or [[]], [])
+
+	packs = []
+	if args.file:
+		fp = Path(args.file)
+		if fp.is_file():
+			packs = fp.read_text("utf-8").strip().splitlines()
+
+	packs.extend(functools.reduce(operator.iadd, args.pack or [[]], []))
 	if len(packs) == 0:
 		while True:
 			name = input("Enter sticker_set url (leave blank to stop): ").strip()

tstickers/downloader.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import re
 import time
 import urllib.parse
 from concurrent.futures import ThreadPoolExecutor, as_completed
@@ -10,13 +11,46 @@
 from sys import exit as sysexit
 from typing import Any
 
-from emoji import demojize
+from emoji import EMOJI_DATA
 from loguru import logger
 
 from tstickers import caching
 from tstickers.convert import Backend, assure_dir_exists, convertAnimated, convertStatic
 
 
+def demojize(emoji: str) -> str:
+	"""Similar to the emoji.demojize function.
+
+	However, returns a string of unique keywords in alphabetical order seperated by "_"
+
+	:param str emoji: emoji unicode char
+	:return str: returns a string of unique keywords in alphabetical order seperated by "_"
+	"""
+
+	def c14n_part(part: str) -> str:
+		return re.sub(r"_!@#$%^&*'", "_", part).replace("-", "_").lower()
+
+	def merge_parts(parts: set[str]) -> str:
+		unique_set = set()
+		for part in parts:
+			unique_set.update(part.split("_"))
+
+		unique_set.discard("")
+		unique_set.discard("with")
+
+		result_list = sorted(unique_set)
+		return "_".join(result_list)
+
+	emoji_data = EMOJI_DATA.get(emoji)
+	if emoji_data is None:
+		return "unknown"
+
+	parts = {c14n_part(emoji_data.get("en", "").strip(":"))}
+	parts.update(c14n_part(x.strip(":")) for x in emoji_data.get("alias", []))
+
+	return merge_parts(parts)
+
+
 class Sticker:
 	"""Sticker instance attributes."""
 
@@ -37,7 +71,7 @@ def __repr__(self) -> str:
 
 	def emojiName(self) -> str:
 		"""Get the emoji as a string."""
-		return demojize(self.emoji)[1:-1]
+		return demojize(self.emoji)
 
 
 class StickerDownloader: