Skip to main content

Custom Emoji manager command-line for Mattermost 😎

Project description

PyPI Build Status Quality Gate


Custom Emoji manager command-line for Mattermost 😎


  • Create custom Emojis
  • Delete custom Emojis
  • List custom Emojis
  • Search custom Emojis
  • Export custom Emojis


pip install mmemoji
mmemoji --help

(Requires Python >=3.8)

Usage example

Let's take the Party Parrot Emojis as an example.

  • First, clone the Git repository or retrieve an archive of it:
git clone
  • 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:
export MM_URL=''
export MM_LOGIN_ID=''
export MM_PASSWORD='user-1'
  • Finally, run mmemoji to import all the parrots:
mmemoji create --no-clobber {parrots,guests}/hd/*.gif {parrots,guests}/*.gif


  • Here we rely on shell globbing to select all emojis 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.
  • If you ever want to remove them all, simply run the following:
mmemoji delete --force {parrots,guests}/hd/*.gif {parrots,guests}/*.gif


  • The emoji names are extracted from the filenames the same way they have been during creation.
  • --force is used to ignore the absent low quality duplicates.


  • You can clone this repository and install the project with Poetry:
poetry install
  • You'll find a script to create a local Docker test instance under tests/:
  • You can run the test suite with:
  • And last thing, you can install the pre-commit hooks to help with the formatting of your code.
pre-commit install

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mmemoji-0.5.0.tar.gz (22.5 kB view hashes)

Uploaded source

Built Distribution

mmemoji-0.5.0-py3-none-any.whl (24.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page