Metadata-Version: 2.1
Name: talkapps-client
Version: 3.1.0
Summary: A client for the Talk stickers API
Home-page: https://github.com/talkapps/talkapps-client
Author: NKDuy
Author-email: kn145660@gmail.com
License: UNKNOWN
Description: # Python client for Talk stickers
        
        A client to interact with the [Talk](https://nkdtalk.web.app/) stickers API.
        
        + Fetch sticker packs
        + Get images files
        + Upload sticker packs
        + etc.
        
        
        > Note: despite its name, this client does not interacts with
        > `talkapps.github.io/sticker-store`, so information defined there (tags, etc.) will **not**
        > be fetched.
        
        > This client connects to the Talk sticker API. Please **do not flood it**.
        
        ## Installation
        
        ```bash
        pip3 install --user talkapps-client
        ```
        
        This module requires `cryptography`, `protobuf`, `anyio`, and `httpx` (but they should
        be installed with the previous command).
        
        ### Downloading a pack
        The `StickerPack` object returned by `await StickersClient().get_pack(<pack_id>,
        <pack_key>)` exposes the following attributes:
        
        + `id` (string): the pack id. Equals to `pack_id`;
        + `key` (string): the pack key. Equals to `pack_key`;
        + `title` (string): the title of the pack;
        + `author` (string): the author of the pack;
        + `nb_stickers` (int): the number of stickers in the pack;
        + `cover` (`Sticker`): the cover sticker;
        + `stickers` (list): the list of stickers in the pack (which are `Sticker`
          objects).
        
        
        A `Sticker` object exposes the following attributes:
        
        + `id` (int): the id of the sticker in the pack;
        + `emoji` (string): 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 Talk credentials** To obtain them, open the Developer
        > Tools in Talk Desktop, and type `window.reduxStore.getState().items.uuid_id`
        > to get your USER, and `window.reduxStore.getState().items.password` to get
        > your PASSWORD.
        
        
        ## Example usage
        
        [See `examples/`](examples/)
        
        ## Development
        
        + Create a `pipenv` with `pipenv install --dev`;
        + Edit the code you want;
        + Don't forget to launch tests with `pipenv run py.test`.
        
        ## License
        
        See [LICENSE](https://github.com/talkapps/talkapps-client/blob/master/LICENSE)
        
        
        ## Legal
        
        This is not an official Talk project. This is an independant project.  
        Talk is a registered trademark in the United States and other countries.
        
        
        ## Author
        
        NKDuy <kn145660@gmail.com>
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Communications :: Chat
Requires-Python: >=3.6
Description-Content-Type: text/markdown
