Download sticker packs from Telegram
The tstickers
package provides functionality for downloading and converting sticker packs from https://t.me/addstickers. Download stickers, and convert them to multiple formats, with caching the converted stickers for faster retrieval.
https://t.me/addstickers/DonutTheDog
python -m tstickers
downloads
folder.More info at Tutorials
Get the URL of the Signal sticker pack. In the form https://t.me/addstickers
Pass in multiple packs from the commandline with -p/--pack
$ tstickers --pack https://t.me/addstickers/DonutTheDog
INFO | ============================================================
INFO | Starting to scrape "DonutTheDog" ..
INFO | Time taken to scrape 31 stickers - 0.044s
INFO |
INFO | ------------------------------------------------------------
INFO | Starting download of "donutthedog" into downloads\donutthedog
INFO | Time taken to download 31 stickers - 0.157s
INFO |
INFO | ------------------------------------------------------------
INFO | -> Cache miss for DonutTheDog!
INFO | Converting stickers "DonutTheDog"...
INFO | Time taken to convert 31 stickers (tgs) - 60.970s
INFO |
INFO | Time taken to convert 31 stickers (webp) - 0.447s
INFO |
INFO | Time taken to convert 62 stickers (total) - 61.434s
INFO |
OR. Enter the URL of the sticker pack when prompted
$ python -m tstickers
Enter sticker_set URL (leave blank to stop): https://t.me/addstickers/DonutTheDog
Enter sticker_set URL (leave blank to stop):
INFO | ============================================================
INFO | Starting to scrape "DonutTheDog" ..
INFO | Time taken to scrape 31 stickers - 0.044s
INFO |
INFO | ------------------------------------------------------------
INFO | Starting download of "donutthedog" into downloads\donutthedog
INFO | Time taken to download 31 stickers - 0.157s
INFO |
INFO | ------------------------------------------------------------
...
Get the output in the downloads
folder.
$ ls .\downloads\donutthedog\
Mode LastWriteTime Length Name
---- ------------- ------ ----
d----- 17/03/2024 17꞉00 apng
d----- 17/03/2024 17꞉01 gif
d----- 17/03/2024 17꞉06 png
d----- 17/03/2024 17꞉00 tgs
d----- 17/03/2024 17꞉02 webp
$ python -m tstickers --help
usage: Welcome to TStickers, providing all of your sticker needs [-h] [-t TOKEN] [-p PACK [PACK ...]]
[--frameskip FRAMESKIP] [--scale SCALE]
[-b {rlottie-python,pyrlottie}]
options:
-h, --help show this help message and exit
-t TOKEN, --token TOKEN
Pass in a bot token inline
-p PACK [PACK ...], --pack PACK [PACK ...]
Pass in a pack url inline
--frameskip FRAMESKIP
Set frameskip. default=1
--scale SCALE Set scale. default=1.0
-b {rlottie-python,pyrlottie}, --backend {rlottie-python,pyrlottie}
Specify the convert backend
A high-level overview of how the documentation is organized organized will help you know
where to look for certain things:
Format | Static | Animated | Animated (webm) |
---|---|---|---|
.gif | ✔ | ✔ | ❌ |
.png | ✔ | ✔+ | ❌ |
.tgs | ❌ | ✔ | ❌ |
.webp | ✔ | ✔ | ❌ |
.webm | ❌ | ❌ | ✔ |
+ First frame of animated image only
Note that static images can fail to save as .gif occasionally in testing
pip install tstickers
Head to https://pypi.org/project/tstickers/ for more info
This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
3.11
choco install python
To install Python, go to https://www.python.org/downloads/windows/ and download the latest
version.
sudo apt install python3.x
sudo dnf install python3.x
brew install python@3.x
To install Python, go to https://www.python.org/downloads/macos/ and download the latest
version.
Module
py -3.x -m [module]
or [module]
(if module installs a script)
File
py -3.x [file]
or ./[file]
Module
python3.x -m [module]
or [module]
(if module installs a script)
File
python3.x [file]
or ./[file]
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
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
For testing with the version of python used by poetry use
poetry run pytest
Alternatively use tox
to run tests over python 3.8 - 3.11
tox
Type ‘git clone’ followed by URL in step 2
git clone https://github.com/FHPythonUtils/TStickers
More information can be found at
https://help.github.com/en/articles/cloning-a-repository
More information can be found at
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
MIT License
Copyright (c) FredHappyface
(See the LICENSE for more information.)
See the Changelog for more information.
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
for more information.
Contributions are welcome, please see the
Contributing Guidelines
for more information.
Thank you for improving the security of the project, please see the
Security Policy
for more information.
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
for more information.
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
for more information.