{"id":13408561,"url":"https://github.com/ilius/pyglossary","last_synced_at":"2026-10-19T07:28:26.454Z","repository":{"id":1338318,"uuid":"1284229","full_name":"ilius/pyglossary","owner":"ilius","description":"A tool for converting dictionary files aka glossaries. Mainly to help use our offline glossaries in any Open Source dictionary we like on any operating system / device.","archived":false,"fork":false,"pushed_at":"2026-10-03T13:26:56.000Z","size":14203,"stargazers_count":2700,"open_issues_count":9,"forks_count":264,"subscribers_count":62,"default_branch":"master","last_synced_at":"2026-10-08T10:21:17.136Z","etag":null,"topics":["dictionary","dictionary-conversion","dictionary-tools","glossaries","gtk","linux","pygi","python","stardict","tkinter"],"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/ilius.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2011-01-23T10:24:30.000Z","updated_at":"2026-10-06T20:38:59.000Z","dependencies_parsed_at":"2023-10-03T06:40:47.700Z","dependency_job_id":"b90628cc-cf45-4243-bf86-4e983a5d6e4f","html_url":"https://github.com/ilius/pyglossary","commit_stats":{"total_commits":3273,"total_committers":39,"mean_commits":83.92307692307692,"dds":0.07760464405743961,"last_synced_commit":"a90c5d5774e0fcc352b3f5878bb7c4a5768f77ba"},"previous_names":[],"tags_count":65,"template":false,"template_full_name":null,"purl":"pkg:github/ilius/pyglossary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilius%2Fpyglossary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilius%2Fpyglossary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilius%2Fpyglossary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilius%2Fpyglossary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ilius","download_url":"https://codeload.github.com/ilius/pyglossary/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilius%2Fpyglossary/sbom","scorecard":{"id":484219,"data":{"date":"2025-08-11","repo":{"name":"github.com/ilius/pyglossary","commit":"02e07e9132ca76f28770dbc51970f4f3afcf56a6"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.3,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 4 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 1/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:39","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:40","Info: jobLevel 'packages' permission set to 'read': .github/workflows/codeql.yml:36","Warn: no topLevel permission defined: .github/workflows/codeql.yml:1","Warn: no topLevel permission defined: .github/workflows/gen.yml:1","Warn: no topLevel permission defined: .github/workflows/mdformat.yml:1","Warn: no topLevel permission defined: .github/workflows/pip-mac.yml:1","Warn: no topLevel permission defined: .github/workflows/pypi-release.yml:1","Warn: no topLevel permission defined: .github/workflows/ruff.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: no topLevel permission defined: .github/workflows/validate-plugins.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:86: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gen.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/gen.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gen.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/gen.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/mdformat.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/mdformat.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/mdformat.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/mdformat.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-mac.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/pip-mac.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-mac.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/pip-mac.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-mac.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/pip-mac.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi-release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/pypi-release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pypi-release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/pypi-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ruff.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/ruff.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-plugins.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/validate-plugins.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-plugins.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/ilius/pyglossary/validate-plugins.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating bitnami/minideb to bitnami/minideb@sha256:c08bf1955a4051f9d44245f049c06c24282de8ff5a6db22df63b054967e33e0c","Warn: pipCommand not pinned by hash: scripts/mypy-deps.sh:1","Warn: pipCommand not pinned by hash: scripts/release-new-version-github:46","Warn: pipCommand not pinned by hash: scripts/test-deps.sh:1","Warn: pipCommand not pinned by hash: scripts/type-checker-deps.sh:3","Warn: pipCommand not pinned by hash: .github/workflows/gen.yml:26","Warn: pipCommand not pinned by hash: .github/workflows/mdformat.yml:26","Warn: pipCommand not pinned by hash: .github/workflows/pip-mac.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/pip-mac.yml:37","Info:   0 out of  17 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   1 out of   9 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/pypi-release.yml:8"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (1) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T17:24:11.126Z","repository_id":1338318,"created_at":"2025-08-19T17:24:11.127Z","updated_at":"2025-08-19T17:24:11.127Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38351626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-19T02:00:06.414Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["dictionary","dictionary-conversion","dictionary-tools","glossaries","gtk","linux","pygi","python","stardict","tkinter"],"created_at":"2024-07-30T20:00:53.672Z","updated_at":"2026-10-19T07:28:26.443Z","avatar_url":"https://github.com/ilius.png","language":"Python","funding_links":[],"categories":["Python","پایتون Python","Dictionary tools","Developer Resources"],"sub_categories":["Paid and proprietary","Dictionary Data"],"readme":"# PyGlossary\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/ilius/pyglossary/refs/heads/master/res/pyglossary-256x256.png\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n[![PyPI](https://img.shields.io/pypi/v/pyglossary.svg)](https://pypi.org/project/pyglossary/)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/pyglossary)](https://pypi.org/project/pyglossary/)\n[![tests](https://github.com/ilius/pyglossary/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/ilius/pyglossary/actions/workflows/test.yml?query=branch%3Amaster)\n\nA tool for converting dictionary files aka glossaries.\n\nThe primary purpose is to be able to use our offline glossaries in any Open\nSource dictionary we like on any OS/device.\n\nThere are countless formats, and my time is limited, so I implement formats that\nseem more useful for myself, or for Open Source community. Also diversity of\nlanguages is taken into account. Pull requests are welcome.\n\n## Screenshots\n\n\u003cimg src=\"https://raw.githubusercontent.com/wiki/ilius/pyglossary/screenshots/52-gtk3-txt-stardict-aryanpur-dark2.png\" width=\"50%\" height=\"50%\"/\u003e\n\nLinux - Gtk3-based interface\n\n______________________________________________________________________\n\n\u003cimg src=\"https://raw.githubusercontent.com/wiki/ilius/pyglossary/screenshots/52-tk-dsl-stardict-windows-greek.png\" width=\"50%\" height=\"50%\"/\u003e\n\nWindows - Tkinter-based interface\n\n______________________________________________________________________\n\n\u003cimg src=\"https://raw.githubusercontent.com/wiki/ilius/pyglossary/screenshots/32-cmd-freedict-mids-de-ru.png\" width=\"50%\" height=\"50%\"/\u003e\n\nLinux - command-line interface\n\n______________________________________________________________________\n\n\u003cimg src=\"https://raw.githubusercontent.com/wiki/ilius/pyglossary/screenshots/40-cmdi-termux-zim-slob-en-med.jpg\" width=\"50%\" height=\"50%\"/\u003e\n\nAndroid Termux - interactive command-line interface\n\n______________________________________________________________________\n\n\u003cimg src=\"https://raw.githubusercontent.com/wiki/ilius/pyglossary/screenshots/50-web-wiktextract-ifo-ar.png\" width=\"50%\" height=\"50%\"/\u003e\n\nWeb interface\n\n## Supported formats\n\n| Format | | Extension | Read | Write |\n| ------------------------------------------------------- | :-: | :-------------: | :--: | :---: |\n| [Aard 2 (slob)](./doc/p/aard2_slob.md) | 🔢 | .slob | ✅ | ✅ |\n| [AppleDict Binary](./doc/p/appledict_bin.md) | 📁 | .dictionary | ✅ | ❌ |\n| [AppleDict Source](./doc/p/appledict.md) | 📁 | | ✅ | ✅ |\n| [Babylon BGL](./doc/p/babylon_bgl.md) | 🔢 | .bgl | ✅ | ✅ |\n| [CSV](./doc/p/csv.md) | 📝 | .csv | ✅ | ✅ |\n| [Dict.cc translation export](./doc/p/dict_cc_source.md) | 📝 | .txt | ✅ | ❌ |\n| [DICT.org / Dictd server](./doc/p/dict_org.md) | 📁 | (📝.index) | ✅ | ✅ |\n| [DICT.org / dictfmt source](./doc/p/dict_org_source.md) | 📝 | (.dtxt) | | ✅ |\n| [dictunformat output file](./doc/p/dictunformat.md) | 📝 | (.dictunformat) | ✅ | |\n| [DictionaryForMIDs](./doc/p/dicformids.md) | 📁 | (📁.mids) | ✅ | ✅ |\n| [DIKT JSON](./doc/p/dikt_json.md) | 📝 | (.json) | | ✅ |\n| [EPUB-2 E-Book](./doc/p/epub2.md) | 📦 | .epub | ❌ | ✅ |\n| [FreeDict](./doc/p/freedict.md) | 📝 | .tei | ✅ | ❌ |\n| [FreeDict Markdown](./doc/p/freedict_md.md) | 📝 | .tei | ✅ | ❌ |\n| [Gettext Source](./doc/p/gettext_po.md) | 📝 | .po | ✅ | ✅ |\n| [HTML Directory (by file size)](./doc/p/html_dir.md) | 📁 | | ❌ | ✅ |\n| [JSON](./doc/p/json.md) | 📝 | .json | | ✅ |\n| [Kobo E-Reader Dictionary](./doc/p/kobo.md) | 📦 | .kobo.zip | ❌ | ✅ |\n| [Kobo E-Reader Dictfile](./doc/p/kobo_dictfile.md) | 📝 | .df | ✅ | ✅ |\n| [Lingoes Source](./doc/p/lingoes_ldf.md) | 📝 | .ldf | ✅ | ✅ |\n| [Mobipocket E-Book](./doc/p/mobi.md) | 🔢 | .mobi | ❌ | ✅ |\n| [Octopus MDict](./doc/p/octopus_mdict.md) | 🔢 | .mdx | ✅ | ❌ |\n| [PocketBook SDIC](./doc/p/pocketbook_sdic.md) | 🔢 | .dic | ❌ | ✅ |\n| [QuickDic version 6](./doc/p/quickdic6.md) | 🔢 | .quickdic | ✅ | ✅ |\n| [SQL](./doc/p/sql.md) | 📝 | .sql | ❌ | ✅ |\n| [StarDict](./doc/p/stardict.md) | 📁 | (📝.ifo) | ✅ | ✅ |\n| [StarDict Textual File](./doc/p/stardict_textual.md) | 📝 | (.xml) | ✅ | ✅ |\n| [Tabfile](./doc/p/tabfile.md) | 📝 | .txt, .tab | ✅ | ✅ |\n| [TMX](./doc/p/tmx.md) | 📝 | .tmx | ✅ | |\n| [Wiktextract](./doc/p/wiktextract.md) | 📝 | .jsonl | ✅ | ❌ |\n| [XDXF](./doc/p/xdxf.md) | 📝 | .xdxf | ✅ | ❌ |\n| [XLIFF](./doc/p/xliff.md) | 📝 | .xlf, .xliff | ✅ | |\n| [Zim (Kiwix)](./doc/p/zim.md) | 🔢 | .zim | ✅ | |\n| [ABBYY Lingvo DSL](./doc/p/dsl.md) 🇷🇺 | 📝 | .dsl | ✅ | ❌ |\n| [Almaany.com](./doc/p/almaany.md) (Arabic) | 🛢️ | .db | ✅ | ❌ |\n| [cc-kedict](./doc/p/cc_kedict.md) 🇰🇷 | 📝 | | ✅ | ❌ |\n| [Dict.cc](./doc/p/dict_cc.md) 🇩🇪 | 🛢️ | .db | ✅ | |\n| [DigitalNK](./doc/p/digitalnk.md) 🇰🇵 | 🛢️ | .db | ✅ | |\n| [EDICT2 (CEDICT)](./doc/p/edict2.md) 🇨🇳 | 📝 | (.u8) | ✅ | ❌ |\n| [EPWING](./epwing.md) 🇯🇵 | 📁 | | ✅ | ❌ |\n| [JMDict](./doc/p/jmdict.md) 🇯🇵 | 📝 | | ✅ | ❌ |\n| [JMnedict](./doc/p/jmnedict.md) 🇯🇵 | 📝 | | ✅ | ❌ |\n| [WordNet](./doc/p/wordnet.md) 🇬🇧 | 📁 | | ✅ | ❌ |\n| [WordFrequency.info](./doc/p/wordfrequency.md) 🇬🇧 | 📝 | .wordfrequency | ✅ | ❌ |\n| [@wordset dictionary](./doc/p/wordset.md) 🇬🇧 | 📁 | | ✅ | |\n| [Yomichan / Yomitan](./doc/p/yomichan.md) 🇯🇵 | 📦 | (.zip) | ✅ | ✅ |\n\nLegend:\n\n- 📁 Directory\n- 📝 Text file\n- 📦 Package/archive file\n- 🛢️ SQLite file\n- 🔢 Binary file\n- ✅ Supported\n- ❌ Will not be supported\n\n**Note**: SQLite-based formats are not detected by extension (`.db`);\nSo you need to select the format (with UI or `--read-format` flag).\n**Also don't confuse SQLite-based formats with [SQLite mode](#sqlite-mode).**\n\n## Requirements\n\nPyGlossary requires **Python 3.12 or higher**, and works in practically all\nmainstream operating systems, including *GNU/Linux*, *Windows*, *Mac OS*,\n*FreeBSD* and other common Unix-based operating systems.\n\nAs shown in screenshots, there are multiple User Interface types (multiple\nways to use the program).\n\n- **Gtk3-based interface**, uses [PyGI](http://pygobject.readthedocs.io/en/latest/getting_started.html)+Gtk3.\n  Best option for most Linux users.\n  See [doc/gtk3.md](./doc/gtk3.md) for how to install it on Linux and Mac OS X.\n\n- **Gtk4-based interface**, uses [PyGI](http://pygobject.readthedocs.io/en/latest/getting_started.html)+Gtk4.\n  See [doc/gtk4.md](./doc/gtk4.md).\n\n- **Qt6-based interface**, good native-looking interface for all operating systems.\n  Requires either PySide6 or PyQt6. Uses a wizard-based UI flow for simplicity of use.\n\n- **wxPython-based interface**, wizard-style GUI using wxPython. Install with\n  `pip install pyglossary[wx]` (or install `wxPython` separately).\n\n- **Tkinter-based interface**, meant to be used in the lack of more modern UI. Specially on\n  Windows where Tkinter library is installed with Python itself.\n  You can [install Tkinter](./doc/tkinter.md) on Linux or Mac OS X.\n\n- **Command-line interface**, works in all operating systems without\n  any specific requirements, just type `./main.py --help` or `pyglossary --help`\n\n  - **Interactive command-line interface**\n    - Requires: `pip install prompt_toolkit`\n    - Perfect for mobile devices (like Termux on Android) where no GUI is available\n    - Automatically selected if output file argument is not passed **and** one of these:\n      - On Linux and `$DISPLAY` environment variable is empty or not set\n        - For example when you are using a remote Linux machine over SSH\n      - On Mac and no `tkinter` module is found\n    - Manually select with `--cmd` or `--ui=cmd`\n      - Minimally: `./main.py --cmd`\n      - You can still pass input file, or any flag/option\n    - If both input and output files are passed, non-interactive cmd ui will be default.\n      - Pass `--interactive` to change it.\n    - If you are writing a script, you can pass `--no-interactive` to force disable interactive ui\n      - Then you have to pass both input and output file arguments\n    - Don't forget to use *Up/Down* or *Tab* keys in prompts!\n      - Up/Down key shows you recent values you have used\n      - Tab key shows available values/options\n    - You can press Control+C (on Linux/Windows) at any prompt to exit\n\n## UI (User Interface) selection\n\nWhen you run PyGlossary without any command-line arguments or options/flags, PyGlossary will try to run the first available interface:\n\n- It tries to find PyGI+Gtk3 and open **Gtk3-based** interface.\n- It tries to find PyGI+Gtk4 and open **Gtk4-based** interface.\n- It tries to find PySide6 or PyQt6 and open **Qt 6** interface.\n- It tries to find wxPython and open **wxPython-based** interface.\n- It tries to find Tkinter and open the **classic Tkinter** interface.\n- It tries to open the **Tk wizard** interface (also Tkinter-based).\n- If it's run in command line (with stdin connected to a terminal) it tries to find `prompt_toolkit` and run **interactive command-line** interface.\n- It runs a HTTP server and opens the **web interface** in your browser.\n\nThe order depends on operating system. On **GNU/Linux** the default order is Gtk3, Gtk4, Qt 6, wxPython, Tkinter (classic), Tk wizard, then web. On **Mac OS** and **Windows**, Qt 6, wxPython, and the Tk wizard are tried before classic Tkinter and Gtk.\n\nYou can explicitly select user interface type using `--ui`\n\n- `./main.py --ui=gtk3`\n- `./main.py --ui=gtk4`\n- `./main.py --ui=gtk` which currently selects `gtk3`\n- `./main.py --ui=qt6` or `./main.py --ui=qt`: Qt 6 wizard-based interface\n- `./main.py --ui=wx` or `./main.py --wx`: wxPython wizard-based interface\n- `./main.py --ui=tk`\n- `./main.py --ui=tk_wizard`: new wizard-based Tkinter interface\n  - Shortcut: `./main.py --tkw`\n- `./main.py --ui=web`\n- `./main.py --ui=cmd` with no extra arguments opens interactive command-line interface\n\n## Installation on Windows\n\nYou can either download the latest `setup.exe` from [Releases](https://github.com/ilius/pyglossary/releases) and install it via a wizard, or install it using Python and `pip`:\n\n- [Download and install latest Python](https://www.python.org/downloads/windows/)\n- Open Start -\u003e type Command -\u003e right-click on Command Prompt -\u003e Run as administrator\n- To ensure you have `pip`, run: `python -m ensurepip --upgrade`\n- To install, run: `pip install --upgrade pyglossary`\n- Now you should be able to run `pyglossary` command\n- If command was not found, make sure Python environment variables are set up:\n  \u003cimg src=\"https://raw.githubusercontent.com/wiki/ilius/pyglossary/screenshots/windows-python39-env-vars.png\" width=\"50%\" height=\"50%\"/\u003e\n\n## Installation on Mac OS (14 \u0026 15)\n\nIf you download the DMG file from [Releases](https://github.com/ilius/pyglossary/releases) and install it, Mac may refuse to run it, showing **the app is damaged and cannot be opened** error. In that case, move the unpacked bundle to `/Applications`, and run this from the Terminal:\n\n```\n/usr/bin/xattr -d com.apple.quarantine /Applications/PyGlossaryWX.app\n```\n\nOr\n\n```\n/usr/bin/xattr -d com.apple.quarantine /Applications/PyGlossaryTK.app\n```\n\nNow you should be able to open the app by **right-clicking** on **/Applications/PyGlossary.app** in Finder, selecting **Open** and confirming running an app unsigned by Apple (only needs to be done once).\n\n## Feature-specific requirements\n\n- Using [Sort by Locale](#sorting) feature requires [PyICU](./doc/pyicu.md)\n\n- Using `--remove-html-all` flag requires:\n\n  `pip install lxml beautifulsoup4`\n\nSome formats have additional requirements.\nIf you have trouble with any format, please check the [link given for that format](#supported-formats) to see its documentations.\n\nThe **Qt 6 wizard** GUI (`--ui=qt`, `--ui=qt6`, `--qt`, or `--qt6`) needs PySide6 or PyQt6: `pip install pyglossary[qt6]` (or install `PySide6` separately). On macOS, that extra also installs **`pyobjc-framework-Cocoa`** so the Dock and app switcher can show PyGlossary’s icon (standalone `python`/CLI runs do not ship an `.app` bundle icon otherwise).\n\nThe **wxPython wizard** GUI (`--ui=wx` or `--wx`) needs wxPython: `pip install pyglossary[wx]` (or install `wxPython` separately). On macOS, that extra also installs **`pyobjc-framework-Cocoa`** for the same Dock icon behaviour as the Qt extra.\n\n**Using Termux on Android?** See [doc/termux.md](./doc/termux.md)\n\n## Configuration\n\nSee [doc/config.rst](./doc/config.rst).\n\n## Direct and indirect modes\n\nIndirect mode means that input glossary is completely read and loaded into RAM, then converted\ninto output format. This was the only method available in old versions (before [3.0.0](https://github.com/ilius/pyglossary/releases/tag/3.0.0)).\n\nDirect mode means entries are one-at-a-time read, processed and written into output glossary.\n\nDirect mode was added to limit memory usage for large glossaries; But it may reduce the\nconversion time for most cases as well.\n\nConverting glossaries into these formats requires [sorting](#sorting) entries:\n\n- [StarDict](./doc/p/stardict.md)\n- [EPUB-2](./doc/p/epub2.md)\n- [Mobipocket E-Book](./doc/p/mobi.md)\n- [Yomichan](./doc/p/yomichan.md)\n- [DictionaryForMIDs](./doc/p/dicformids.md)\n\nThat's why direct mode will not work for these formats, and PyGlossary has to\nswitch to indirect mode (or it previously had to, see [SQLite mode](#sqlite-mode)).\n\nFor other formats, direct mode will be default. You may override this by `--indirect` flag.\n\n## SQLite mode\n\nAs mentioned above, converting glossaries to some specific formats will\nneed them to loaded into RAM.\n\nThis can be problematic if the glossary is too big to fit into RAM. That's when\nyou should try adding `--sqlite` flag to your command. Then it uses SQLite3 as intermediate\nstorage for storing, sorting and then fetching entries. This fixes the memory issue, and may\neven reduce running time of conversion (depending on your home directory storage).\n\nThe temporary SQLite file is stored in [cache directory](#cache-directory) then\ndeleted after conversion (unless you pass `--no-cleanup` flag).\n\nSQLite mode is automatically enabled for writing these formats if `auto_sqlite`\n[config parameter](./doc/config.rst) is `true` (which is default).\nThis also applies to when you pass `--sort` flag for any format.\nYou may use `--no-sqlite` to override this and switch to indirect mode.\n\nCurrently you can not disable alternates in SQLite mode (`--no-alts` is ignored).\n\n## Sorting\n\nThere are two things than can activate sorting entries:\n\n- Output format requires sorting (as explained [above](#direct-and-indirect-modes))\n- You pass `--sort` flag in command line.\n\nIn the case of passing `--sort`, you can also pass:\n\n- `--sort-key` to select sort key aka sorting order (including locale), see [doc/sort-key.md](./doc/sort-key.md)\n\n- `--sort-encoding` to change the encoding used for sort\n\n  - UTF-8 is the default encoding for all sort keys and all output formats (unless mentioned otherwise)\n  - This will only effect the order of entries, and will not corrupt words / definition\n  - Non-encodable characters are replaced with `?` byte (*only for sorting*)\n\n## Cache directory\n\nCache directory is used for storing temporary files which are either moved or deleted\nafter conversion. You can pass `--no-cleanup` flag in order to keep them.\n\nThe path for cache directory:\n\n- Linux or BSD: `~/.cache/pyglossary/`\n- Mac: `~/Library/Caches/PyGlossary/`\n- Windows: `C:\\Users\\USERNAME\\AppData\\Local\\PyGlossary\\Cache\\`\n\n## User plugins\n\nIf you want to add your own plugin without adding it to source code directory,\nor you want to use a plugin that has been removed from repository,\nyou can place it in this directory:\n\n- Linux or BSD: `~/.pyglossary/plugins/`\n- Mac: `~/Library/Preferences/PyGlossary/plugins/`\n- Windows: `C:\\Users\\USERNAME\\AppData\\Roaming\\PyGlossary\\plugins\\`\n\n## Linux packaging status\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/pyglossary.svg?columns=3\u0026header=PyGlossary)](https://repology.org/project/pyglossary/versions)\n\n## Using PyGlossary as a library\n\nSee [doc/lib-usage.md](./doc/lib-usage.md) for how to use PyGlossary as a Python library.\n\n## Plugin development\n\nTo learn how to develop plugins, see [test plugin](./pyglossary/plugins/testformat/) as a basic example, or [CSV plugin](./pyglossary/plugins/csv_plugin) for example.\n\nWhenever you add a new plugin, or change options/metedata of an existing plugin, make sure to run [`./scripts/gen`](./scripts/gen) script to update generated files (index and documentation) that we keep.\n\n## Internals\n\nSee [doc/internals.md](./doc/internals.md) for information about internal glossary structure and entry filters.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filius%2Fpyglossary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Filius%2Fpyglossary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filius%2Fpyglossary/lists"}