{"id":18666662,"url":"https://github.com/fhpythonutils/tstickers","last_synced_at":"2025-04-11T23:33:00.360Z","repository":{"id":44736310,"uuid":"326525705","full_name":"FHPythonUtils/TStickers","owner":"FHPythonUtils","description":"Download sticker packs from Telegram","archived":false,"fork":false,"pushed_at":"2024-03-30T15:23:49.000Z","size":6695,"stargazers_count":35,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-25T06:20:51.475Z","etag":null,"topics":["python","sticker-pack","telegram","telegram-stickers"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FHPythonUtils.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-04T00:04:24.000Z","updated_at":"2024-08-26T15:59:38.217Z","dependencies_parsed_at":"2023-12-01T21:24:21.692Z","dependency_job_id":"9d633b5f-8d9a-4409-9e5e-0c0294a49c50","html_url":"https://github.com/FHPythonUtils/TStickers","commit_stats":{"total_commits":46,"total_committers":1,"mean_commits":46.0,"dds":0.0,"last_synced_commit":"7cbeac50afe7d1361153865fbccbfa920d62be06"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FHPythonUtils%2FTStickers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FHPythonUtils%2FTStickers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FHPythonUtils%2FTStickers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FHPythonUtils%2FTStickers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FHPythonUtils","download_url":"https://codeload.github.com/FHPythonUtils/TStickers/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248495741,"owners_count":21113691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","sticker-pack","telegram","telegram-stickers"],"created_at":"2024-11-07T08:33:30.308Z","updated_at":"2025-04-11T23:32:58.923Z","avatar_url":"https://github.com/FHPythonUtils.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![GitHub top language](https://img.shields.io/github/languages/top/FHPythonUtils/TStickers.svg?style=for-the-badge\u0026cacheSeconds=28800)](../../)\n[![Issues](https://img.shields.io/github/issues/FHPythonUtils/TStickers.svg?style=for-the-badge\u0026cacheSeconds=28800)](../../issues)\n[![License](https://img.shields.io/github/license/FHPythonUtils/TStickers.svg?style=for-the-badge\u0026cacheSeconds=28800)](/LICENSE.md)\n[![Commit activity](https://img.shields.io/github/commit-activity/m/FHPythonUtils/TStickers.svg?style=for-the-badge\u0026cacheSeconds=28800)](../../commits/master)\n[![Last commit](https://img.shields.io/github/last-commit/FHPythonUtils/TStickers.svg?style=for-the-badge\u0026cacheSeconds=28800)](../../commits/master)\n[![PyPI Downloads](https://img.shields.io/pypi/dm/tstickers.svg?style=for-the-badge\u0026cacheSeconds=28800)](https://pypistats.org/packages/tstickers)\n[![PyPI Total Downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge\u0026label=total%20downloads\u0026query=%24.total_downloads\u0026url=https%3A%2F%2Fapi%2Epepy%2Etech%2Fapi%2Fv2%2Fprojects%2Ftstickers)](https://pepy.tech/project/tstickers)\n[![PyPI Version](https://img.shields.io/pypi/v/tstickers.svg?style=for-the-badge\u0026cacheSeconds=28800)](https://pypi.org/project/tstickers)\n\n\u003c!-- omit in toc --\u003e\n# TStickers - Telegram Sticker Downloader\n\n\u003cimg src=\"readme-assets/icons/name.png\" alt=\"Project Icon\" width=\"750\"\u003e\n\nThe `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.\n\n- [Basic Use](#basic-use)\n- [Using](#using)\n- [Help](#help)\n- [Documentation](#documentation)\n- [Formats](#formats)\n- [Install With PIP](#install-with-pip)\n- [Language information](#language-information)\n\t- [Built for](#built-for)\n- [Install Python on Windows](#install-python-on-windows)\n\t- [Chocolatey](#chocolatey)\n\t- [Windows - Python.org](#windows---pythonorg)\n- [Install Python on Linux](#install-python-on-linux)\n\t- [Apt](#apt)\n\t- [Dnf](#dnf)\n- [Install Python on MacOS](#install-python-on-macos)\n\t- [Homebrew](#homebrew)\n\t- [MacOS - Python.org](#macos---pythonorg)\n- [How to run](#how-to-run)\n\t- [Windows](#windows)\n\t- [Linux/ MacOS](#linux-macos)\n- [Building](#building)\n- [Testing](#testing)\n- [Download Project](#download-project)\n\t- [Clone](#clone)\n\t\t- [Using The Command Line](#using-the-command-line)\n\t\t- [Using GitHub Desktop](#using-github-desktop)\n\t- [Download Zip File](#download-zip-file)\n- [Community Files](#community-files)\n\t- [Licence](#licence)\n\t- [Changelog](#changelog)\n\t- [Code of Conduct](#code-of-conduct)\n\t- [Contributing](#contributing)\n\t- [Security](#security)\n\t- [Support](#support)\n\t- [Rationale](#rationale)\n\n## Basic Use\n\nhttps://t.me/addstickers/DonutTheDog\n\n- NOTE: You need a telegram bot token to make use of the script. Generate a bot\ntoken and paste in a file called 'env'. Send a message to @BotFather to get started.\n- Create a file called 'env' (or env.txt) and paste your token\n- Get the URL of the telegram sticker pack\n- Run the program `python -m tstickers`\n- Enter the URL of the sticker pack\n- Get the output in the `downloads` folder.\n\nMore info at [Tutorials](/documentation/tutorials)\n\n## Using\n\n1. Get the URL of the Signal sticker pack. In the form https://t.me/addstickers\n\n2. Pass in multiple packs from the commandline with `-p/--pack`\n\n\t```bash\n\t$ tstickers --pack https://t.me/addstickers/DonutTheDog\n\tINFO     | ============================================================\n\tINFO     | Starting to scrape \"DonutTheDog\" ..\n\tINFO     | Time taken to scrape 31 stickers - 0.044s\n\tINFO     |\n\tINFO     | ------------------------------------------------------------\n\tINFO     | Starting download of \"donutthedog\" into downloads\\donutthedog\n\tINFO     | Time taken to download 31 stickers - 0.157s\n\tINFO     |\n\tINFO     | ------------------------------------------------------------\n\tINFO     | -\u003e Cache miss for DonutTheDog!\n\tINFO     | Converting stickers \"DonutTheDog\"...\n\tINFO     | Time taken to convert 31 stickers (tgs) - 60.970s\n\tINFO     |\n\tINFO     | Time taken to convert 31 stickers (webp) - 0.447s\n\tINFO     |\n\tINFO     | Time taken to convert 62 stickers (total) - 61.434s\n\tINFO     |\n\n\t```\n\n3. OR. Enter the URL of the sticker pack when prompted\n\n\t```bash\n\t$ python -m tstickers\n\tEnter sticker_set URL (leave blank to stop): https://t.me/addstickers/DonutTheDog\n\tEnter sticker_set URL (leave blank to stop):\n\tINFO     | ============================================================\n\tINFO     | Starting to scrape \"DonutTheDog\" ..\n\tINFO     | Time taken to scrape 31 stickers - 0.044s\n\tINFO     |\n\tINFO     | ------------------------------------------------------------\n\tINFO     | Starting download of \"donutthedog\" into downloads\\donutthedog\n\tINFO     | Time taken to download 31 stickers - 0.157s\n\tINFO     |\n\tINFO     | ------------------------------------------------------------\n\t...\n\t```\n\n4. Get the output in the `downloads` folder.\n\n\t```powershell\n\t$ ls .\\downloads\\donutthedog\\\n\n\tMode                 LastWriteTime         Length Name\n\t----                 -------------         ------ ----\n\td-----        17/03/2024     17꞉00                apng\n\td-----        17/03/2024     17꞉01                gif\n\td-----        17/03/2024     17꞉06                png\n\td-----        17/03/2024     17꞉00                tgs\n\td-----        17/03/2024     17꞉02                webp\n\t```\n\n## Help\n\n```bash\n$ python -m tstickers --help\nusage: Welcome to TStickers, providing all of your sticker needs [-h] [-t TOKEN] [-p PACK [PACK ...]]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t[--frameskip FRAMESKIP] [--scale SCALE]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t[-b {rlottie-python,pyrlottie}]\n\noptions:\n-h, --help            show this help message and exit\n-t TOKEN, --token TOKEN\n\t\t\t\t\t\tPass in a bot token inline\n-p PACK [PACK ...], --pack PACK [PACK ...]\n\t\t\t\t\t\tPass in a pack url inline\n--frameskip FRAMESKIP\n\t\t\t\t\t\tSet frameskip. default=1\n--scale SCALE         Set scale. default=1.0\n-b {rlottie-python,pyrlottie}, --backend {rlottie-python,pyrlottie}\n\t\t\t\t\t\tSpecify the convert backend\n```\n\n## Documentation\n\nA high-level overview of how the documentation is organized organized will help you know\nwhere to look for certain things:\n\n- [Tutorials](/documentation/tutorials) take you by the hand through a series of steps to get\n  started using the software. Start here if you’re new.\n- The [Technical Reference](/documentation/reference) documents APIs and other aspects of the\n  machinery. This documentation describes how to use the classes and functions at a lower level\n  and assume that you have a good high-level understanding of the software.\n\u003c!--\n- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you\n  may have.\n--\u003e\n\n## Formats\n\n| Format | Static | Animated | Animated (webm) |\n| ------ | ------ | -------- | --------------- |\n| .gif   | ✔      | ✔        | ❌               |\n| .png   | ✔      | ✔+       | ❌               |\n| .tgs   | ❌      | ✔        | ❌               |\n| .webp  | ✔      | ✔        | ❌               |\n| .webm  | ❌      | ❌        | ✔               |\n\n```txt\n+ First frame of animated image only\n```\n\nNote that static images can fail to save as .gif occasionally in testing\n\n## Install With PIP\n\n```python\npip install tstickers\n```\n\nHead to https://pypi.org/project/tstickers/ for more info\n\n## Language information\n\n### Built for\n\nThis program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and\n3.11\n\n## Install Python on Windows\n\n### Chocolatey\n\n```powershell\nchoco install python\n```\n\n### Windows - Python.org\n\nTo install Python, go to https://www.python.org/downloads/windows/ and download the latest\nversion.\n\n## Install Python on Linux\n\n### Apt\n\n```bash\nsudo apt install python3.x\n```\n\n### Dnf\n\n```bash\nsudo dnf install python3.x\n```\n\n## Install Python on MacOS\n\n### Homebrew\n\n```bash\nbrew install python@3.x\n```\n\n### MacOS - Python.org\n\nTo install Python, go to https://www.python.org/downloads/macos/ and download the latest\nversion.\n\n## How to run\n\n### Windows\n\n- Module\n\t`py -3.x -m [module]` or `[module]` (if module installs a script)\n\n- File\n\t`py -3.x [file]` or `./[file]`\n\n### Linux/ MacOS\n\n- Module\n\t`python3.x -m [module]` or `[module]` (if module installs a script)\n\n- File\n\t`python3.x [file]` or `./[file]`\n\n## Building\n\nThis project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This\ncommand generates the documentation, updates the requirements.txt and builds the library artefacts\n\nNote the functionality provided by fhmake can be approximated by the following\n\n```sh\nhandsdown  --cleanup -o documentation/reference\npoetry export -f requirements.txt --output requirements.txt\npoetry export -f requirements.txt --with dev --output requirements_optional.txt\npoetry build\n```\n\n`fhmake audit` can be run to perform additional checks\n\n## Testing\n\nFor testing with the version of python used by poetry use\n\n```sh\npoetry run pytest\n```\n\nAlternatively use `tox` to run tests over python 3.8 - 3.11\n\n```sh\ntox\n```\n\n## Download Project\n\n### Clone\n\n#### Using The Command Line\n\n1. Press the Clone or download button in the top right\n2. Copy the URL (link)\n3. Open the command line and change directory to where you wish to\nclone to\n4. Type 'git clone' followed by URL in step 2\n\n\t```bash\n\tgit clone https://github.com/FHPythonUtils/TStickers\n\t```\n\nMore information can be found at\nhttps://help.github.com/en/articles/cloning-a-repository\n\n#### Using GitHub Desktop\n\n1. Press the Clone or download button in the top right\n2. Click open in desktop\n3. Choose the path for where you want and click Clone\n\nMore information can be found at\nhttps://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop\n\n### Download Zip File\n\n1. Download this GitHub repository\n2. Extract the zip archive\n3. Copy/ move to the desired location\n\n## Community Files\n\n### Licence\n\nMIT License\nCopyright (c) FredHappyface\n(See the [LICENSE](/LICENSE.md) for more information.)\n\n### Changelog\n\nSee the [Changelog](/CHANGELOG.md) for more information.\n\n### Code of Conduct\n\nOnline communities include people from many backgrounds. The *Project*\ncontributors are committed to providing a friendly, safe and welcoming\nenvironment for all. Please see the\n[Code of Conduct](https://github.com/FHPythonUtils/.github/blob/master/CODE_OF_CONDUCT.md)\n for more information.\n\n### Contributing\n\nContributions are welcome, please see the\n[Contributing Guidelines](https://github.com/FHPythonUtils/.github/blob/master/CONTRIBUTING.md)\nfor more information.\n\n### Security\n\nThank you for improving the security of the project, please see the\n[Security Policy](https://github.com/FHPythonUtils/.github/blob/master/SECURITY.md)\nfor more information.\n\n### Support\n\nThank you for using this project, I hope it is of use to you. Please be aware that\nthose involved with the project often do so for fun along with other commitments\n(such as work, family, etc). Please see the\n[Support Policy](https://github.com/FHPythonUtils/.github/blob/master/SUPPORT.md)\nfor more information.\n\n### Rationale\n\nThe rationale acts as a guide to various processes regarding projects such as\nthe versioning scheme and the programming styles used. Please see the\n[Rationale](https://github.com/FHPythonUtils/.github/blob/master/RATIONALE.md)\nfor more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffhpythonutils%2Ftstickers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffhpythonutils%2Ftstickers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffhpythonutils%2Ftstickers/lists"}