A client for the Signal stickers API
Project description
NOTICE
This is a fork from https://github.com/signalstickers/signalstickers-client
This fork adds typing and remove dependencies version caps
Python client for Signal stickers
A client to interact with the Signal stickers API.
- Fetch sticker packs
- Get images files
- Upload sticker packs
- etc.
Note: despite its name, this client does not interacts with
signalstickers.org
, so information defined there (tags, etc.) will not be fetched.
This client connects to the Signal sticker API. Please do not flood it (you'll be blocked anyway).
Installation
pip3 install --user signalstickers-client
This module requires cryptography
, protobuf
, anyio
, and httpx
(but they
should be installed with the previous command).
Usage
If you are not familiar with Signal stickers, read STICKERS_INTERNALS.md first.
Downloading a pack
The StickerPack
object returned by await StickersClient().get_pack(<pack_id>, <pack_key>)
exposes the following
attributes:
id: str
the pack id. Equals topack_id
;key: str
the pack key. Equals topack_key
;title: str
the title of the pack;author: str
the author of the pack;nb_stickers: int
the number of stickers in the pack;cover: Sticker
the cover sticker;stickers: list[Sticker]
the list of stickers in the pack
A Sticker
object exposes the following attributes:
id: int
the id of the sticker in the pack;emoji: str
the emoji mapped to this sticker;image_data: bytes
the webp image of the sticker.
Uploading a pack
Same thing, but use LocalStickerPack
(that does not contains id
and key
)
instead of StickerPack
.
You will need your Signal credentials!
To obtain them, run the Signal Desktop app with the flag --enable-dev-tools
,
open the Developer Tools, change the JavaScript context from top
to
Electron Isolated Context
(cf. video below), and type
window.reduxStore.getState().items.uuid_id
to get your USER, and
window.reduxStore.getState().items.password
to get your PASSWORD.
Video: how to set JavaScript context
Example usage
Development
- Create a
pipenv
withpipenv install --dev
; - Edit the code you want;
- Don't forget to launch tests with
pipenv run py.test
.
License
See LICENSE
Legal
This is not an official Signal project. This is an independant project.
Signal is a registered trademark in the United States and other countries.
Author
Romain Ricard contact+stickerclient@romainricard.fr
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for signalstickers-client-fork-laggykiller-3.3.0.post0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7f5030b9fe7f02a51ebaa24043483afe8fa8619c6c238bd40a9c441928b1350 |
|
MD5 | 31d12515e3fb7bddc122abbbdeced26c |
|
BLAKE2b-256 | 01c3228dced2d836a57a398861f4b3354d5c4995baa27af926d391415c9834b5 |
Hashes for signalstickers_client_fork_laggykiller-3.3.0.post0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1dc8dc1d7f9260f88df9e8ba1be10106970231d2e8199f725e2252dc7439ef28 |
|
MD5 | 8d0f028b5b834c068d80c2415d445fa1 |
|
BLAKE2b-256 | 97864b5bbd10674e4c7064dd87807a593badf52ce531e358a81ef844d8008d24 |