{"id":24258170,"url":"https://github.com/alyssabedard/hanzi2pinyin","last_synced_at":"2025-03-04T19:48:55.591Z","repository":{"id":272521223,"uuid":"901651766","full_name":"alyssabedard/Hanzi2Pinyin","owner":"alyssabedard","description":"Anki add-on that adds Pinyin and Zhuyin readings above Chinese characters in any field.","archived":false,"fork":false,"pushed_at":"2025-01-22T01:07:05.000Z","size":27940,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-04T19:48:40.958Z","etag":null,"topics":["anki","anki-addon","bopomofo","cantonese","chinese","flashcards","jyutping","mandarin","pinyin","sentence-mining","xiaoerjing","zhuyin"],"latest_commit_sha":null,"homepage":"https://ankiweb.net/shared/info/77106192","language":"Python","has_issues":true,"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/alyssabedard.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-11T04:07:13.000Z","updated_at":"2025-02-02T19:03:02.000Z","dependencies_parsed_at":"2025-01-22T02:20:00.308Z","dependency_job_id":null,"html_url":"https://github.com/alyssabedard/Hanzi2Pinyin","commit_stats":null,"previous_names":["alyssabedard/hanzi2pinyin"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alyssabedard%2FHanzi2Pinyin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alyssabedard%2FHanzi2Pinyin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alyssabedard%2FHanzi2Pinyin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alyssabedard%2FHanzi2Pinyin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alyssabedard","download_url":"https://codeload.github.com/alyssabedard/Hanzi2Pinyin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241913781,"owners_count":20041461,"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":["anki","anki-addon","bopomofo","cantonese","chinese","flashcards","jyutping","mandarin","pinyin","sentence-mining","xiaoerjing","zhuyin"],"created_at":"2025-01-15T05:31:32.776Z","updated_at":"2025-03-04T19:48:55.572Z","avatar_url":"https://github.com/alyssabedard.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1 style=\"font-family: monospace;\"\u003eHanzi2Pinyin\u003c/h1\u003e\n\u003c!-- Anki Rate --\u003e\u003ca href=\"https://ankiweb.net/shared/info/77106192\"\u003e\u003cimg src=\"https://img.shields.io/badge/AnkiWeb-Rate-6cb5e7?style=for-the-badge\u0026labelColor=grey\u0026logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMDAgMTAwIj48cGF0aCBkPSJNNjYuNTk3IDMxLjgwOGMtLjY0Ljc2My00LjQ1OC0xLjMzNi01LjQyNC0xLjA5NC0uOTY2LjI0Mi0zLjM0MyAzLjg5My00LjI2NyAzLjUyMS0uOTI0LS4zNzItLjEwOC00LjY1Mi0uNjM2LTUuNDk2LS41MjktLjg0NC00LjczNi0xLjk3Ny00LjY2OC0yLjk3LjA2OS0uOTk0IDQuMzkxLTEuNTQgNS4wMy0yLjMwNC42NC0uNzYzLjQxNy01LjExNSAxLjM4NC01LjM1Ny45NjYtLjI0MiAyLjgyIDMuNyAzLjc0NSA0LjA3My45MjMuMzcyIDQuOTkzLTEuMTg0IDUuNTIyLS4zNC41MjkuODQ0LTIuNjQ4IDMuODI2LTIuNzE2IDQuODItLjA2OC45OTMgMi42NyA0LjM4MyAyLjAzIDUuMTQ3eiIgc3R5bGU9ImZpbGw6IzAwODRkZDtzdHJva2U6I2ZmZmZmZjtzdHJva2Utd2lkdGg6MiIvPjxwYXRoIGQ9Ik01OS43MTIgODIuMzU2Yy0yLjMzNSAyLjc4OS0xNi4yOC00Ljg3Ny0xOS44MDgtMy45OTMtMy41MjguODgzLTEyLjIxMiAxNC4yMTgtMTUuNTg2IDEyLjg2LTMuMzc0LTEuMzYtLjM5My0xNi45OS0yLjMyMy0yMC4wNzMtMS45MzEtMy4wODItMTcuMjk3LTcuMjItMTcuMDQ3LTEwLjg1LjI1LTMuNjI4IDE2LjAzNy01LjYyMyAxOC4zNzItOC40MTIgMi4zMzUtMi43ODggMS41MjMtMTguNjggNS4wNS0xOS41NjQgMy41MjktLjg4NCAxMC4zMDUgMTMuNTE0IDEzLjY3OCAxNC44NzMgMy4zNzQgMS4zNTkgMTguMjM4LTQuMzI1IDIwLjE2OC0xLjI0MyAxLjkzMSAzLjA4My05LjY2OSAxMy45NzYtOS45MTggMTcuNjA1LS4yNSAzLjYyOCA5Ljc0OCAxNi4wMDggNy40MTQgMTguNzk3eiIgc3R5bGU9ImZpbGw6IzAwODRkZDtzdHJva2U6I2ZmZmZmZjtzdHJva2Utd2lkdGg6MiIvPjwvc3ZnPg==\" /\u003e\u003c/a\u003e\n\u003c!-- GitHub Release --\u003e\u003ca href=\"https://github.com/alyssabedard/Hanzi2Pinyin/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/alyssabedard/Hanzi2Pinyin?style=for-the-badge\u0026labelColor=%231C1C1C\u0026color=%23A692E3\u0026logo=github\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\u003cbr\u003e\n    \u003cimg src=\"docs/screenshots/demo-liuqi.gif\" width=\"600\" alt=\"Demo of Hanzi2Pinyin\"/\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n💜 For the \u003cspan style=\"color:#CBC3E3;\"\u003eQuick Start Guide\u003c/span\u003e click \u003ca style=\"color:#9c87db;\" href=\"https://github.com/alyssabedard/Hanzi2Pinyin/blob/master/docs/quick_start_guide.md\"\u003ehere\u003c/a\u003e💜\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\nTo download the companion Anki note type click \u003ca style=\"color:#9c87db;\" href=\"https://github.com/alyssabedard/Hanzi2Pinyin-notetype\"\u003ehere\u003c/a\u003e\n\u003c/div\u003e\n\n\n## Description\nThis [Anki](https://apps.ankiweb.net/) add-on lets you add **Pinyin** and **Zhuyin** readings above Chinese characters \n(Hanzi) in **any field**.\n\nIt works by converting your Chinese text into [ruby](https://en.wikipedia.org/wiki/Ruby_character) annotations, where \nthe Pinyin appears as small text \nabove the original characters, making it easier to read and study Chinese text.\n\n_[Why Hanzi2Pinyin when there are other great add-ons?](#why-Hanzi2Pinyin-when-there-are-other-great-add-ons)_\n\n\u003e ⚠️ For the [ruby](https://en.wikipedia.org/wiki/Ruby_character) annotation to work\n\u003e use this [Anki note type](https://github.com/alyssabedard/Hanzi2Pinyin-notetype) made specifically for this add-on.\n\u003e \n\u003e Read the [Anki documentation on Ruby characters](https://docs.ankiweb.net/templates/fields.html?highlight=furigana#ruby-characters).\n \n\n\n_Looking for the Quick Start Guide? Need help? Want to raise an issue? Looking for documentation? See [Contributing \u0026 Support](#contributing--support)_\n\n\u003cdiv align=\"center\"\u003e\n\u003cb\u003eExample\u003c/b\u003e\n\u003c/div\u003e\n\n\n\n| Type          | Pinyin                                                                        | Zhuyin                                                                         |\n|---------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| Hanzi         | 你好                                                                            | 你好                                                                             |\n| Hanzi to Ruby | `你[nǐ]好[hǎo]`                                                                 | `你[ㄋㄧˇ]好[ㄏㄠˇ]`                                                                 |\n| HTML Code     | `\u003cruby\u003e你\u003crt\u003enǐ\u003c/rt\u003e\u003c/ruby\u003e\u003cruby\u003e好\u003crt\u003ehǎo\u003c/rt\u003e\u003c/ruby\u003e`                         | `\u003cruby\u003e你\u003crt\u003eㄋㄧˇ\u003c/rt\u003e\u003c/ruby\u003e\u003cruby\u003e好\u003crt\u003eㄏㄠˇ\u003c/rt\u003e\u003c/ruby\u003e`                         |\n| HTML Output   | \u003cdiv align=\"center\"\u003e\u003cruby\u003e你\u003crt\u003enǐ\u003c/rt\u003e\u003c/ruby\u003e\u003cruby\u003e好\u003crt\u003ehǎo\u003c/rt\u003e\u003c/ruby\u003e\u003c/div\u003e | \u003cdiv align=\"center\"\u003e\u003cruby\u003e你\u003crt\u003eㄋㄧˇ\u003c/rt\u003e\u003c/ruby\u003e\u003cruby\u003e好\u003crt\u003eㄏㄠˇ\u003c/rt\u003e\u003c/ruby\u003e\u003c/div\u003e |\n\n\n\n## Demo\n\n\u003cdiv align=\"center\"\u003e\u003cbr\u003e\n    \u003cimg src=\"docs/screenshots/demo-pinyin.gif\" width=\"800\" alt=\"Demo of Hanzi2Pinyin\"/\u003e\n   \u003cimg src=\"docs/screenshots/demo-sentencepinyin.gif\" width=\"500\" alt=\"Demo\"/\u003e\n    \u003cdiv\u003e⬇️\u003c/div\u003e\n   \u003cimg src=\"docs/screenshots/demo-sentencepinyin-html.gif\" width=\"400\" alt=\"Demo\"/\u003e\n\u003c/div\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eDemo with Zhuyin\u003c/summary\u003e\n    \u003cdiv align=\"center\"\u003e\u003cbr\u003e\n        \u003cimg src=\"docs/screenshots/demo-zhuyin.gif\" width=\"800\" alt=\"Demo of Hanzi2Pinyin\"/\u003e\n    \u003c/div\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eDemo Tools settings (macOS)\u003c/summary\u003e\n    \u003cdiv align=\"center\"\u003e\u003cbr\u003e\n        \u003cimg src=\"docs/screenshots/demo-settings.gif\" width=\"800\" alt=\"Demo of Hanzi2Pinyin\"/\u003e\n    \u003c/div\u003e\n\u003c/details\u003e\n\n## Features\n- [x] Pinyin support - _Browse_ editor dialog\n- [x] Pinyin support - _Add_ editor dialog\n- [x] Zhuyin (Bopomofo) support \n- [x] Note Type that supports ruby text for Chinese\n\nKey benefits:\n- Works with any field name of your choosing (No restrictions)\n- Simple and reliable functionality\n- Support both Simplified and Traditional Chinese Characters \n\n### Planned Features\n\n| Status | Feature                | Details                                                              |\n|--------|------------------------|----------------------------------------------------------------------|\n| 🔄     | Bulk add/remove        | Available in tools menu                                              |\n| 🔄     | Jyutping and Cantonese | Support for Cantonese pronunciation                                  |\n| 🔄     | Xiao'erjing            | Support for Arabic-Persian script (also known as Xiaor jin/Xiaojing) |\n| 🔄     | Sandhi                 | Support for phonological changes between adjacent tones _(Note 1)_   |\n\n\u003e Note 1: Sandhi refers to how tones change when certain tones/words are next to each other in \n\u003e speech. For example, in Mandarin, when a hanzi with the third \n\u003e tone is followed by another hanzi with the third tone, \n\u003e the first hanzi changes to second tone instead.\n\nI plan on making additional Chinese language tools that will be \nreleased as separate add-ons to maintain simplicity as \nI prefer single-purpose add-ons.\n\n\n## Why Hanzi2Pinyin when there are other great add-ons?\nThis add-on focuses on simplicity and flexibility. While many add-ons offer extensive features, \nthey often come with drawbacks:\n- Break when Anki or Qt versions are updated\n- Restrict you to specific field names\n- Bundle multiple features you might not need\n\n\n## Contributing \u0026 Support\n\n| Type                                                                     | Description                     |\n|--------------------------------------------------------------------------|---------------------------------|\n| [Issues \u0026 Requests](https://github.com/alyssabedard/Hanzi2Pinyin/issues) | Bug reports or feature requests | \n| [Contributing](.github/CONTRIBUTING.md)                                  | Fork the repo and submit a PR   |\n| [Discussions](https://github.com/alyssabedard/Hanzi2Pinyin/discussions)  | Getting help and questions      |\n| [Support](.github/SUPPORT.md)                                            | Support                         |\n| [Quick Start Guide](docs/quick_start_guide.md)                           | Quick Start Guide               |\n| [Technical documentation](docs/development.md)                           | Technical documentation         |\n\n**OS**  \nThis script has been primarily tested on macOS and Windows.  I currently don't have access \nto a Linux machine for thorough testing.\n\n\n## Acknowledgements\n\n### Libraries\n| Library | Links |\n|---------|-------|\n| jieba | [PyPi](https://pypi.org/project/jieba/), [GitHub](https://github.com/fxsjy/jieba) |\n| pypinyin | [PyPi](https://pypi.org/project/pypinyin/), [GitHub](https://github.com/mozillazg/python-pinyin) |\n\n### Other\n| Description   | Source                                 |\n|---------------|----------------------------------------|\n| Anki SVG logo | [Glutanimate](https://glutanimate.com) |\n\n\n\u003cdiv align=\"center\"\u003e\u003cbr\u003e\n    \u003cp\u003e加油\u003c/p\u003e\n    \u003cimg src=\"docs/screenshots/liuqi-jiayou.gif\" width=\"200\" alt=\"Demo of Hanzi2Pinyin\"/\u003e\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falyssabedard%2Fhanzi2pinyin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falyssabedard%2Fhanzi2pinyin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falyssabedard%2Fhanzi2pinyin/lists"}