Metadata-Version: 2.1
Name: packpath
Version: 0.9.4
Summary: Automatically upload Signal stickers from a given path and YAML configuration
Home-page: https://github.com/diegoe/packpath
Author: Diego Escalante Urrelo
Author-email: diegoe@gnome.org
License: AGPL-3.0-only
Project-URL: GitHub, https://github.com/diegoe/packpath
Description: ![Mosaic of custom Signal stickers with the Signal logo in the middle](https://github.com/diegoe/packpath/blob/main/packpath-cover.jpg?raw=true)
        
        
        # packpath
        Automatically upload Signal stickers from a given path and YAML configuration
        
        
        ## Install it
        
        The package is available in PyPI, through `pip`:
        ```sh
          $ pip3 install packpath
        ```
        
        But you can also simply checkout this repository and run it as a module:
        ```sh
          $ git clone https://github.com/diegoe/packpath.git
          $ cd packpath
          $ python3 -m packpath (plus arguments, see below)
        ```
        
        ## How it works
        
        `packpath` reads a path and loads a `config.yaml` file from it to automatically
        fill a `signalstickers-client` client, and submit stickers.
        
        It subclasses `signalstickers_client.models.LocalStickerPack` to add a
        `load_path()` method.
        
        You need to provide your username and password, as well as the path to a
        sticker directory containing a `config.yaml` file. See below for details
        on both, or run `packpath --help`:
        
        ```sh
          $ packpath --user [uuid_id] --password [password] [path_to_sticker_dir]
        
          # Most of this README and its instructions are available in the
          # command's help:
          $ packpath --help
        ```
        
        
        ## YAML format
        
        The YAML format is rather simple:
        
        ```yaml
        pack:
          title: Your sticker pack title
          author: An author name
          cover: filename-for-the-cover.png
        
        stickers:
          filename.png: 👀
          another-filename.png: 👋
          (...)
        ```
        
        To save yourself some work, you can use `ls` to output an almost ready
        list of filenames to use on your `config.yaml`:
        
        ```sh
          $ ls -1 >> config.yaml
        ```
        
        
        ## Signal credentials
        
        From https://github.com/signalstickers/signalstickers-client#uploading-a-pack:
        
        > You will need your Signal credentials To obtain them, open the
        > Developer Tools in Signal Desktop, and type
        > window.reduxStore.getState().items.uuid_id to get your USER, and
        > window.reduxStore.getState().items.password to get your PASSWORD.
        
        The above is also available in `python3 -m packpath --help`.
        
        
        ## Credits
        
        This is a simple wrapper on top of the very handy
        [`signalstickers-client`](https://github.com/signalstickers/signalstickers-client).
        
        Go check it out.
        
        
        ## Disclaimer
        
        All boiler plate disclaimers apply. But also please be respectful of
        Signal's service. Don't abuse this or any other script. This is meant to
        help legitimate users make the most of the service.
        
        
        ## Development
        
        Make sure to run flake8 on any changes you make, and also to run the
        tests:
        ```sh
          $ flake8 packpath
          $ python3 -m unittest discover
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
