{"id":17818290,"url":"https://github.com/questionlp/fetch-mastodon-custom-emoji","last_synced_at":"2025-04-02T09:15:05.366Z","repository":{"id":101708370,"uuid":"571923675","full_name":"questionlp/fetch-mastodon-custom-emoji","owner":"questionlp","description":"Basic Python script used to fetch and save custom emojis using Mastodon custom emoji API endpoint","archived":false,"fork":false,"pushed_at":"2022-12-30T20:37:40.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-08T00:26:01.769Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/questionlp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-11-29T07:14:31.000Z","updated_at":"2022-11-29T07:15:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"0765d452-ca05-453e-847e-afc1af3b430a","html_url":"https://github.com/questionlp/fetch-mastodon-custom-emoji","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/questionlp%2Ffetch-mastodon-custom-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/questionlp%2Ffetch-mastodon-custom-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/questionlp%2Ffetch-mastodon-custom-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/questionlp%2Ffetch-mastodon-custom-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/questionlp","download_url":"https://codeload.github.com/questionlp/fetch-mastodon-custom-emoji/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246785487,"owners_count":20833497,"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":[],"created_at":"2024-10-27T16:49:03.652Z","updated_at":"2025-04-02T09:15:05.343Z","avatar_url":"https://github.com/questionlp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fetch-mastodon-custom-emoji\n\nA very rudimentary Python script that fetches the list of and downloads a copy of custom emojis from a Mastodon instance, using the custom emoji API endpoint. The script downloads each custom emoji, saving them into an output directory and names each file based on the custom emoji's short code.\n\nThis script requires Python 3.6 or newer, though it is only tested with Python 3.8 and 3.10.\n\n## Setting Up the Script\n\nIncluded in this repository is a `requirements.txt` file that includes any of the required packages that the script needs to run. To install the dependencies, run the following command (preferably in a virtual environment):\n\n```bash\npip3 install -r requirements.txt\n```\n\n## Using the Script\n\nIn order to use the Python script to download custom emojis from a Mastodon instance, you will need to define the custom emoji API endpoint for that instance. By default, the custom emoji API endpoint path is `/api/v1/custom_emojis`.\n\nFor example, if you want to download custom emojis from a Mastodon instance available at `mastodon.example.org`, the default custom emoji API endpoint for that instance would be:\n\n```text\nhttps://mastodon.example.org/api/v1/custom_emojis\n```\n\nTo use the script against any given custom emoji API endpoint, you would pass that URL as an argument when running the script:\n\n```bash\npython3 fetch.py [-o output-path] custom-emoji-api-endpoint\n```\n\nThe `-o` option is used to save the downloaded custom emoji files to a specific location. By default, the script will create a directory named `output` (if it doesn't already exist) and save the files directly into the directory.\n\n## Code of Conduct\n\nThis project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to version 2.1 of the [Contributor Covenant](http://contributor-covenant.org) code of conduct. A copy of the [code of conduct](CODE_OF_CONDUCT.md) is included in this repository.\n\n## License\n\nThis project is licensed under the terms of the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquestionlp%2Ffetch-mastodon-custom-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquestionlp%2Ffetch-mastodon-custom-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquestionlp%2Ffetch-mastodon-custom-emoji/lists"}