{"id":15017316,"url":"https://github.com/xylous/grzegorz","last_synced_at":"2025-04-12T11:42:10.934Z","repository":{"id":38227430,"uuid":"503793324","full_name":"xylous/grzegorz","owner":"xylous","description":"A comand-line phonetics tool for finding minimal pairs","archived":false,"fork":false,"pushed_at":"2023-11-11T13:22:22.000Z","size":501,"stargazers_count":17,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T06:24:09.893Z","etag":null,"topics":["anki","cli","command-line","language-learning","linguistics","minimal-pairs","phonology","python","utility"],"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/xylous.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}},"created_at":"2022-06-15T14:10:13.000Z","updated_at":"2025-03-12T04:54:58.000Z","dependencies_parsed_at":"2023-11-11T14:43:55.765Z","dependency_job_id":null,"html_url":"https://github.com/xylous/grzegorz","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xylous%2Fgrzegorz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xylous%2Fgrzegorz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xylous%2Fgrzegorz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xylous%2Fgrzegorz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xylous","download_url":"https://codeload.github.com/xylous/grzegorz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248563661,"owners_count":21125324,"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","cli","command-line","language-learning","linguistics","minimal-pairs","phonology","python","utility"],"created_at":"2024-09-24T19:50:18.010Z","updated_at":"2025-04-12T11:42:10.911Z","avatar_url":"https://github.com/xylous.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grzegorz\n\n`grzegorz` is a linguistics tool which primarily concerns minimal pairs. For a\ndetailed history of the project's development, check the\n[Changelog](./Changelog.md)\n\n#### Overview\n\nNOTE: throughout the documentation, \"IPA\" is used as an abbreviation for\n[International Phonetic\nAlphabet](https://en.wikipedia.org/wiki/International_Phonetic_Alphabet)\ntranscription.\n\n- [What are minimal pairs?](./doc/minimal-pairs.md)\n- [Usage manual](./doc/USER-MANUAL.md), contains brief technical descriptions of\n    everything\n- [Quickshot phonological parsing](./doc/phonological-analysis.md)\n- [Getting a decently-sized wordlist](./doc/wordlist.md)\n- [Fetching International Phonetic Alphabet spellings](./doc/ipa-fetch.md)\n- [Finding minimal pairs with the help of the generator](./doc/generator.md)\n- [Creating an Anki deck and importing it into the app](./doc/anki-integration.md)\n- [The convenient `fullmake` command](./doc/fullmake.md)\n\n## Getting started\n\n### Requirements\n\n- python3\n- pip\n\n### Installation\n\nMake sure the pip installation directory (default: `${HOME}/.local/bin`) is on\nyour `${PATH}`. If not, add it (to your `.bashrc` or `.zshrc` preferably):\n\n```\nexport PATH=\"${HOME}/.local/bin:${PATH}\"\n```\n\n#### From PyPi\n\n```\n$ pip install grzegorz\n```\n\n#### From source\n\nClone this repository and run pip:\n\n```\n$ git clone https://github.com/xylous/grzegorz grzegorz\n$ cd grzegorz\n$ pip install .\n```\n\n### Usage\n\nCheck [the \"overview\" section](#overview)\n\n## Roadmap\n\n- [x] fetch a wordlist of most used words in a given language\n- [x] fetch the International Phonetic Alphabet spelling for a given wordlist\n- [x] generate minimal pairs\n    - [x] look for phoneme differences\n        - [x] optimise: look for interesting differences\n        - [x] optimise: ignore stressed syllables\n    - [x] look for chroneme differences\n    - [x] look for syllable stress differences\n- [x] Anki integration\n    - [x] create Anki flashcards from the generated minimal pairs\n    - [x] export a deck containing the created flashcards\n    - [ ] ~~add audio pronunciations for every flashcard~~\n- [ ] print phonetical analysis of a word:\n    - [x] given its IPA\n    - [ ] given its language\n- [x] check if two words form a minimal pair, given their IPAs\n- [ ] search and print the IPA of a word in a given language (on the English\n    Wiktionary)\n- [ ] minimise side effects of functions, delegate commands to wrappers around\n    class functions\n- [ ] documentation\n    - [x] technical docs for usage as a binary\n    - [x] \"tutorial\" for usage as a binary\n    - [ ] technical docs for usage as a library\n    - [ ] \"tutorial\" for usage as a library\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to\ndiscuss what you would like to change.\n\nBut, honestly, the greatest contribution you can make is to add International\nPhonetic Alphabet (IPA) spellings to words on the [English\nWiktionary](https://en.wiktionary.org), which is the source for all the\nspellings that `grzegorz` uses. The more IPA spellings there are, the higher the\nnumber of words that can be used, the more possibilities for minimal pairs.\n\n## License\n\n[GPLv3](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxylous%2Fgrzegorz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxylous%2Fgrzegorz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxylous%2Fgrzegorz/lists"}