SigStickers - Signal Sticker Downloader

The sigstickers package provides functionality for downloading and converting sticker packs from https://signal.art/addstickers (find packs at https://www.sigstick.com/). Download stickers in WebP format, and convert them to PNG and GIF formats, with caching the converted stickers for faster retrieval.

Key Features
Using
Formats
Documentation
Install With PIP
Language information
- Built for
Install Python on Windows
- Chocolatey
- Windows - Python.org
Install Python on Linux
- Apt
- Dnf
Install Python on MacOS
- Homebrew
- MacOS - Python.org
How to run
- Windows
- Linux/ MacOS
Building
Testing
Download Project
- Clone
  - Using The Command Line
  - Using GitHub Desktop
- Download Zip File
Community Files
- Licence
- Changelog
- Code of Conduct
- Contributing
- Security
- Support
- Rationale

Key Features

Sticker Pack Downloading from Signal from their https://signal.art/addstickers url
Sticker Pack Conversion from the WebP format to PNG and GIF formats, making them compatible with various platforms and applications.
Caching Functionality to store converted sticker images locally, reducing the need to re-convert them
Asynchronous Processing for downloading and converting sticker packs

Using

Get the URL of the Signal sticker pack. In the form https://signal.art/addstickers (find packs at https://www.sigstick.com/)

Pass in multiple packs from the commandline with -p/--pack

$ python -m sigstickers --help
usage: Welcome to SigSticker, providing all of your sticker needs [-h] [-p PACK [PACK ...]]

options:
-h, --help            show this help message and exit
-p PACK [PACK ...], --pack PACK [PACK ...]
						Pass in a pack URL inline

$ python -m sigstickers --pack 'https://signal.art/addstickers/#pack_id=b676ec334ee2f771cadff5d095971e8c&pack_key=c957a57000626a2dc3cb69bf0e79c91c6b196b74d4d6ca1cbb830d3ad0ad4e36'

2024-03-17 00:14:16.354 | INFO     | sigstickers.downloader:download_pack:82 - ============================================================
2024-03-17 00:14:16.805 | INFO     | sigstickers.downloader:download_pack:88 - Starting to scrape "DonutTheDog" ...
2024-03-17 00:14:16.812 | INFO     | sigstickers.downloader:download_pack:89 - Time taken to scrape 28 stickers - 0.999s
2024-03-17 00:14:16.813 | INFO     | sigstickers.downloader:download_pack:90 -
2024-03-17 00:14:16.816 | INFO     | sigstickers.downloader:download_pack:96 - ------------------------------------------------------------
2024-03-17 00:14:16.820 | INFO     | sigstickers.downloader:download_pack:97 - Starting download of "DonutTheDog" into ...\downloads\DonutTheDog
2024-03-17 00:14:16.894 | INFO     | sigstickers.downloader:convert_pack:151 - ------------------------------------------------------------
2024-03-17 00:14:16.897 | INFO     | sigstickers.caching:verify_converted:35 - -> Cache miss for DonutTheDog!
2024-03-17 00:14:16.905 | INFO     | sigstickers.downloader:convert_pack:163 - Converting stickers "DonutTheDog"...
2024-03-17 00:14:29.655 | INFO     | sigstickers.downloader:convert_pack:171 - Time taken to convert 28/28 stickers - 12.749s
2024-03-17 00:14:29.656 | INFO     | sigstickers.downloader:convert_pack:175 -

OR. Enter the URL of the sticker pack

$ python -m sigstickers
Enter sticker_set URL (leave blank to stop): https://signal.art/addstickers/#pack_id=b676ec334ee2f771cadff5d095971e8c&pack_key=c957a57000626a2dc3cb69bf0e79c91c6b196b74d4d6ca1cbb830d3ad0ad4e36
Enter sticker_set URL (leave blank to stop):
2024-03-17 00:18:25.528 | INFO     | sigstickers.downloader:download_pack:82 - ============================================================
2024-03-17 00:18:26.415 | INFO     | sigstickers.downloader:download_pack:88 - Starting to scrape "DonutTheDog" ...
2024-03-17 00:18:26.417 | INFO     | sigstickers.downloader:download_pack:89 - Time taken to scrape 28 stickers - 0.885s
2024-03-17 00:18:26.420 | INFO     | sigstickers.downloader:download_pack:90 -
2024-03-17 00:18:26.426 | INFO     | sigstickers.downloader:download_pack:96 - ------------------------------------------------------------
2024-03-17 00:18:26.428 | INFO     | sigstickers.downloader:download_pack:97 - Starting download of "DonutTheDog" into ...\downloads\DonutTheDog
2024-03-17 00:18:26.497 | INFO     | sigstickers.downloader:convert_pack:151 - ------------------------------------------------------------
2024-03-17 00:18:26.524 | INFO     | sigstickers.caching:verify_converted:33 - -> Cache hit for DonutTheDog!

Get the output in the downloads folder.

$ ls .\downloads\DonutTheDog\

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
d-----        17/03/2024     00꞉14                gif
d-----        17/03/2024     00꞉14                png
d-----        17/03/2024     00꞉08                webp

$ ls .\downloads\DonutTheDog\webp

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a----        17/03/2024     00꞉18         285292 0+face_with_tears_of_joy+😂.webp
-a----        17/03/2024     00꞉18         271726 1+face_blowing_a_kiss+😘.webp
-a----        17/03/2024     00꞉18         306995 10+smiling_face_with_horns+😈.webp
-a----        17/03/2024     00꞉18         293578 11+partying_face+🥳.webp
-a----        17/03/2024     00꞉18         266627 12+angry_face+😠.webp

Formats

Format	Static	Animated
.gif	✔$	✔$
.png	✔	+
.webp	✔	✔

+ The first frame of an animated image is saved as png
$ Some images saved as gif do not render as expected

Documentation

A high-level overview of how the documentation is organized organized will help you know where to look for certain things:

The Technical Reference documents APIs and other aspects of the machinery. This documentation describes how to use the classes and functions at a lower level and assume that you have a good high-level understanding of the software.

Install With PIP

pip install sigstickers

Head to https://pypi.org/project/sigstickers/ for more info

Language information

Built for

This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and 3.11

Install Python on Windows

Chocolatey

choco install python

Windows - Python.org

To install Python, go to https://www.python.org/downloads/windows/ and download the latest version.

Install Python on Linux

Apt

sudo apt install python3.x

Dnf

sudo dnf install python3.x

Install Python on MacOS

Homebrew

brew install python@3.x

MacOS - Python.org

To install Python, go to https://www.python.org/downloads/macos/ and download the latest version.

How to run

Windows

Module py -3.x -m [module] or [module] (if module installs a script)
File py -3.x [file] or ./[file]

Linux/ MacOS

Module python3.x -m [module] or [module] (if module installs a script)
File python3.x [file] or ./[file]

Building

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

Testing

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

Download Project

Clone

Using The Command Line

Press the Clone or download button in the top right
Copy the URL (link)
Open the command line and change directory to where you wish to clone to

Type 'git clone' followed by URL in step 2

git clone https://github.com/FHPythonUtils/SigStickers

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

Press the Clone or download button in the top right
Click open in desktop
Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

Download this GitHub repository
Extract the zip archive
Copy/ move to the desired location

Community Files

Licence

MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)

Changelog

See the Changelog for more information.

Code of Conduct

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.

Contributing

Contributions are welcome, please see the Contributing Guidelines for more information.

Security

Thank you for improving the security of the project, please see the Security Policy for more information.

Support

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.

Rationale

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.