Metadata-Version: 2.1
Name: mmemoji
Version: 0.1.0
Summary: Custom Emoji manager command-line for Mattermost 😎
Home-page: https://github.com/maxbrunet/mmemoji
License: GPLv3
Description: [![PyPI][pypi badge]][pypi link]
        [![Build Status][build badge]][build link]
        [![codecov][codecov badge]][codecov link]
        
        # mmemoji
        
        Custom Emoji manager command-line for [Mattermost][mattermost] 😎
        
        Features:
        
        * Create custom Emojis
        * Delete custom Emojis
        
        Coming soon:
        
        * List custom Emojis
        * Search custom Emojis
        * Export custom Emojis
        
        ## Installation
        
        
        ```shell
        pip install mmemoji
        mmemoji --help
        ```
        
        _(Requires Python >=3.4)_
        
        ## Usage example
        
        Let's take the [Party Parrot][COTPP] Emojis as an example.
        
        * First, clone the Git repository or retrieve an archive of it:
        
        ```shell
        git clone https://github.com/jmhobbs/cultofthepartyparrot.com.git
        cd cultofthepartyparrot.com
        ```
        
        * Then you'll need your Mattermost credentials. You can either pass them to `mmemoji` with the arguments `--url`/`--login-id`/`--password` or via environment variables, for example:
        
        ```shell
        export MM_URL='http://127.0.0.1:8065/api/v4'
        export MM_LOGIN_ID='user-1@sample.mattermost.com'
        export MM_PASSWORD='user-1'
        ```
        
        * Finally, run `mmemoji` to import all the parrots:
        
        ```shell
        mmemoji create --no-clobber {parrots,guests}/hd/*.gif {parrots,guests}/*.gif
        ```
        
        _Notes_:
        
        * Here we rely on [shell globbing][glob] to select all Emoji from the directories.
        * Specifying the `hd` directories first with `--no-clobber` ensures these Emojis are created first and not overwritten by their lower quality counterpart.
        
        ## Development
        
        * You can clone this repository and install the project in editable mode:
        
        ```shell
        pip install -e .
        ```
        
        * You'll find a script to create a local [Docker][docker] test instance under `tests/`:
        
        ```shell
        ./tests/scripts/setup.sh
        ```
        
        * You can run the test suite with:
        
        ```shell
        python setup.py test
        ```
        
        * And last thing, you can install the [pre-commit][pre-commit] hooks to help with the formatting of your code.
        
        ```shell
        pre-commit install
        ```
        
        [pypi badge]: https://img.shields.io/pypi/v/mmemoji.svg
        [pypi link]: https://pypi.python.org/pypi/mmemoji
        [build badge]: https://travis-ci.com/maxbrunet/mmemoji.svg
        [build link]: https://travis-ci.com/maxbrunet/mmemoji
        [codecov badge]: https://codecov.io/gh/maxbrunet/mmemoji/badge.svg
        [codecov link]: https://codecov.io/gh/maxbrunet/mmemoji
        [mattermost]: https://www.mattermost.org
        [COTPP]: https://cultofthepartyparrot.com
        [glob]: https://en.wikipedia.org/wiki/Glob_(programming)
        [docker]: https://www.docker.com
        [pre-commit]: https://pre-commit.com
        
Keywords: cli emoji mattermost
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Utilities
Requires-Python: >=3.4
Description-Content-Type: text/markdown
