{"id":17150281,"url":"https://github.com/maxbrunet/mmemoji","last_synced_at":"2025-04-13T11:52:19.973Z","repository":{"id":33975849,"uuid":"164887885","full_name":"maxbrunet/mmemoji","owner":"maxbrunet","description":"Custom Emoji manager command-line for Mattermost 😎","archived":false,"fork":false,"pushed_at":"2025-04-09T23:00:15.000Z","size":1873,"stargazers_count":24,"open_issues_count":4,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T00:18:41.842Z","etag":null,"topics":["cli","emoji","mattermost"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxbrunet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-09T15:25:12.000Z","updated_at":"2025-04-09T23:00:19.000Z","dependencies_parsed_at":"2024-01-26T22:25:11.784Z","dependency_job_id":"528ab0da-df15-4eda-bc2f-ad05cbf371f0","html_url":"https://github.com/maxbrunet/mmemoji","commit_stats":{"total_commits":275,"total_committers":2,"mean_commits":137.5,"dds":"0.19999999999999996","last_synced_commit":"684008d26ef3a3d1b7afa9d358670011056b5b95"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxbrunet%2Fmmemoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxbrunet%2Fmmemoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxbrunet%2Fmmemoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxbrunet%2Fmmemoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxbrunet","download_url":"https://codeload.github.com/maxbrunet/mmemoji/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248142906,"owners_count":21054671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","emoji","mattermost"],"created_at":"2024-10-14T21:35:17.090Z","updated_at":"2025-04-13T11:52:19.948Z","avatar_url":"https://github.com/maxbrunet.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PyPI][pypi badge]][pypi link]\n[![Build Status][build badge]][build link]\n[![Quality Gate][sonarcloud badge]][sonarcloud link]\n\n# mmemoji\n\nCustom Emoji manager command-line for [Mattermost][mattermost] 😎\n\nFeatures:\n\n* Create custom Emojis\n* Delete custom Emojis\n* List custom Emojis\n* Search custom Emojis\n* Export custom Emojis\n\n## Installation\n\n\n```shell\npip install mmemoji\nmmemoji --help\n```\n\n_(Requires Python \u003e=3.9)_\n\n## Usage example\n\nLet's take the [Party Parrot][COTPP] Emojis as an example.\n\n* First, clone the Git repository or retrieve an archive of it:\n\n```shell\ngit clone https://github.com/jmhobbs/cultofthepartyparrot.com.git\ncd cultofthepartyparrot.com\n```\n\n* 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:\n\n```shell\nexport MM_URL='http://127.0.0.1:8065/api/v4'\nexport MM_LOGIN_ID='user-1@sample.mattermost.com'\nexport MM_PASSWORD='user-1'\n```\n\n* Finally, run `mmemoji` to import all the parrots:\n\n```shell\nmmemoji create --no-clobber {parrots,guests}/hd/*.gif {parrots,guests}/*.gif\n```\n\n\u003e **Note**\n\u003e\n\u003e * Here we rely on [shell globbing][glob] to select all emojis from the directories.\n\u003e * Specifying the `hd` directories first with `--no-clobber` ensures these emojis are created first and not overwritten by their lower quality counterpart.\n\n* If you ever want to remove them all, simply run the following:\n\n```shell\nmmemoji delete --force {parrots,guests}/hd/*.gif {parrots,guests}/*.gif\n```\n\n\u003e **Note**\n\u003e\n\u003e * The emoji names are extracted from the filenames the same way they have been during creation.\n\u003e * `--force` is used to ignore the absent low quality duplicates.\n\n## Development\n\n* You can clone this repository and install the project with [uv][uv]:\n\n```shell\nuv sync\n```\n\n* You'll find a script to create a local [Docker][docker] test instance under `tests/`:\n\n```shell\n./tests/scripts/setup-mattermost.sh\n```\n\n* You can run the test suite with:\n\n```shell\npytest\n```\n\n* And last thing, you can install the [pre-commit][pre-commit] hooks to help with the formatting of your code.\n\n```shell\npre-commit install\n```\n\n[pypi badge]: https://img.shields.io/pypi/v/mmemoji.svg\n[pypi link]: https://pypi.python.org/pypi/mmemoji\n[build badge]: https://github.com/maxbrunet/mmemoji/actions/workflows/build.yml/badge.svg\n[build link]: https://github.com/maxbrunet/mmemoji/actions/workflows/build.yml\n[sonarcloud badge]: https://sonarcloud.io/api/project_badges/measure?project=maxbrunet_mmemoji\u0026metric=alert_status\n[sonarcloud link]: https://sonarcloud.io/dashboard?id=maxbrunet_mmemoji\n[mattermost]: https://github.com/mattermost/mattermost-server\n[COTPP]: https://cultofthepartyparrot.com\n[glob]: https://en.wikipedia.org/wiki/Glob_(programming)\n[docker]: https://www.docker.com\n[pre-commit]: https://pre-commit.com\n[uv]: https://docs.astral.sh/uv\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxbrunet%2Fmmemoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxbrunet%2Fmmemoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxbrunet%2Fmmemoji/lists"}