# Python GTK Spellcheck
[](https://pypi.python.org/pypi/pygtkspellcheck)
[](https://pygtkspellcheck.readthedocs.org/en/latest/)
Python GTK Spellcheck is a simple but quite powerful spellchecking library for GTK written in pure Python. It's spellchecking component is based on [Enchant](http://www.abisource.com/projects/enchant/) and it supports both GTK 3 and 4 via [PyGObject](https://live.gnome.org/PyGObject/).
**⚡️ News:** Thanks to [@cheywood](https://github.com/cheywood), Python GTK Spellcheck now supports GTK 4! 🎉
**🟢 Status:** This project is mature, actively maintained, and open to contributions and co-maintainership.
## ✨ Features
- **spellchecking** based on [Enchant](http://www.abisource.com/projects/enchant/) for `GtkTextView`
- support for word, line, and multiline **ignore regular expressions**
- support for both **GTK 3 and 4** via [PyGObject](https://live.gnome.org/PyGObject/) for Python 3
- configurable extra word characters such as `'`
- localized names of the available languages based on [ISO-Codes](http://pkg-isocodes.alioth.debian.org/)
- support for custom ignore tags and hot swap of `GtkTextBuffer`
- support for Hunspell (LibreOffice) and Aspell (GNU) dictionaries
<p align="center">
<img src="https://raw.githubusercontent.com/koehlma/pygtkspellcheck/master/docs/screenshots/screenshot.png" alt="Screenshot" />
</p>
## 🚀 Getting Started
Python GTK Spellcheck is available from the [Python Package Index](https://pypi.python.org/pypi/pygtkspellcheck):
```sh
pip install pygtkspellcheck
```
Depending on your distribution, you may also find Python GTK Spellcheck in your package manager.
For instance, on Debian you may want to install the [`python3-gtkspellcheck`](https://packages.debian.org/bullseye/python3-gtkspellcheck) package.
## 🥳 Showcase
Over time, several projects have used Python GTK Spellcheck or are still using it. Among those are:
- [Nested Editor](http://nestededitor.sourceforge.net/about.html): “Specialized editor for structured documents.”
- [Cherry Tree](http://www.giuspen.com/cherrytree/): “A hierarchical note taking application, […].”
- [Zim](http://zim-wiki.org/): “Zim is a graphical text editor used to maintain a collection of wiki pages.”
- [REMARKABLE](http://remarkableapp.github.io/): “The best markdown editor for Linux and Windows.”
- [RedNotebook](http://rednotebook.sourceforge.net/): “RedNotebook is a modern journal.”
- [Reportbug](https://packages.debian.org/stretch/reportbug): “Reports bugs in the Debian distribution.”
- [UberWriter](http://uberwriter.wolfvollprecht.de/): “UberWriter is a writing application for markdown.”
- [Gourmet](https://github.com/thinkle/gourmet): “Gourmet Recipe Manager is a manager, editor, and organizer for recipes.“
## 🔖 Versions
Version numbers follow [Semantic Versioning](http://semver.org/). However, the update from 3 to 4 pertains only API incompatible changes in `oxt_extract` and not the spellchecking component. The update from 4 to 5 removed support for Python 2, GTK 2, `pylocales`, and the `oxt_extract` API. Otherwise, the API is still compatible with version 3.
## 📚 Documentation
The documentation is available at [Read the Docs](http://pygtkspellcheck.readthedocs.org/).
## 🏗 Contributing
We welcome all kinds of contributions! ❤️
For minor changes and bug fixes feel free to simply open a pull request. For major changes impacting the overall design of Python GTK Spellcheck, please first [start a discussion](https://github.com/koehlma/pygtkspellcheck/discussions/new?category=ideas) outlining your idea.
By submitting a PR, you agree to license your contributions under “GPLv3 or later”.
Raw data
{
"_id": null,
"home_page": "https://github.com/koehlma/pygtkspellcheck",
"name": "pygtkspellcheck",
"maintainer": "",
"docs_url": "https://pythonhosted.org/pygtkspellcheck/",
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Maximilian K\u00f6hl",
"author_email": "mail@koehlma.de",
"download_url": "https://files.pythonhosted.org/packages/35/86/b2b69f35ddbbc67420823b2819e7a820ae5b8114138d365e536d93b01897/pygtkspellcheck-5.0.2.tar.gz",
"platform": null,
"description": "# Python GTK Spellcheck\n\n[](https://pypi.python.org/pypi/pygtkspellcheck)\n[](https://pygtkspellcheck.readthedocs.org/en/latest/)\n\nPython GTK Spellcheck is a simple but quite powerful spellchecking library for GTK written in pure Python. It's spellchecking component is based on [Enchant](http://www.abisource.com/projects/enchant/) and it supports both GTK 3 and 4 via [PyGObject](https://live.gnome.org/PyGObject/).\n\n**\u26a1\ufe0f News:** Thanks to [@cheywood](https://github.com/cheywood), Python GTK Spellcheck now supports GTK 4! \ud83c\udf89\n\n**\ud83d\udfe2 Status:** This project is mature, actively maintained, and open to contributions and co-maintainership.\n\n\n## \u2728 Features\n\n- **spellchecking** based on [Enchant](http://www.abisource.com/projects/enchant/) for `GtkTextView`\n- support for word, line, and multiline **ignore regular expressions**\n- support for both **GTK 3 and 4** via [PyGObject](https://live.gnome.org/PyGObject/) for Python 3\n- configurable extra word characters such as `'`\n- localized names of the available languages based on [ISO-Codes](http://pkg-isocodes.alioth.debian.org/)\n- support for custom ignore tags and hot swap of `GtkTextBuffer`\n- support for Hunspell (LibreOffice) and Aspell (GNU) dictionaries\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/koehlma/pygtkspellcheck/master/docs/screenshots/screenshot.png\" alt=\"Screenshot\" />\n</p>\n\n\n## \ud83d\ude80 Getting Started\n\nPython GTK Spellcheck is available from the [Python Package Index](https://pypi.python.org/pypi/pygtkspellcheck):\n```sh\npip install pygtkspellcheck\n```\nDepending on your distribution, you may also find Python GTK Spellcheck in your package manager.\nFor instance, on Debian you may want to install the [`python3-gtkspellcheck`](https://packages.debian.org/bullseye/python3-gtkspellcheck) package.\n\n\n## \ud83e\udd73 Showcase\n\nOver time, several projects have used Python GTK Spellcheck or are still using it. Among those are:\n\n- [Nested Editor](http://nestededitor.sourceforge.net/about.html): \u201cSpecialized editor for structured documents.\u201d\n- [Cherry Tree](http://www.giuspen.com/cherrytree/): \u201cA hierarchical note taking application, [\u2026].\u201d\n- [Zim](http://zim-wiki.org/): \u201cZim is a graphical text editor used to maintain a collection of wiki pages.\u201d\n- [REMARKABLE](http://remarkableapp.github.io/): \u201cThe best markdown editor for Linux and Windows.\u201d\n- [RedNotebook](http://rednotebook.sourceforge.net/): \u201cRedNotebook is a modern journal.\u201d\n- [Reportbug](https://packages.debian.org/stretch/reportbug): \u201cReports bugs in the Debian distribution.\u201d\n- [UberWriter](http://uberwriter.wolfvollprecht.de/): \u201cUberWriter is a writing application for markdown.\u201d\n- [Gourmet](https://github.com/thinkle/gourmet): \u201cGourmet Recipe Manager is a manager, editor, and organizer for recipes.\u201c\n\n\n## \ud83d\udd16 Versions\n\nVersion numbers follow [Semantic Versioning](http://semver.org/). However, the update from 3 to 4 pertains only API incompatible changes in `oxt_extract` and not the spellchecking component. The update from 4 to 5 removed support for Python 2, GTK 2, `pylocales`, and the `oxt_extract` API. Otherwise, the API is still compatible with version 3.\n\n\n## \ud83d\udcda Documentation\n\nThe documentation is available at [Read the Docs](http://pygtkspellcheck.readthedocs.org/).\n\n\n## \ud83c\udfd7 Contributing\n\nWe welcome all kinds of contributions! \u2764\ufe0f\n\nFor minor changes and bug fixes feel free to simply open a pull request. For major changes impacting the overall design of Python GTK Spellcheck, please first [start a discussion](https://github.com/koehlma/pygtkspellcheck/discussions/new?category=ideas) outlining your idea.\n\nBy submitting a PR, you agree to license your contributions under \u201cGPLv3 or later\u201d.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "A simple but quite powerful spellchecking library for GTK written in pure Python.",
"version": "5.0.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d3e25e6927a82929b9b05f9b4abb7bebd6cd04ec8ba9231ce79b190ae3eb40b",
"md5": "53249de966677c9bb9746e704cf6de93",
"sha256": "6eaab2391f94c81428eb10092b9fd314b46a29bca4b8ce70bd43eb4258a836c8"
},
"downloads": -1,
"filename": "pygtkspellcheck-5.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "53249de966677c9bb9746e704cf6de93",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 46344,
"upload_time": "2023-04-17T18:19:21",
"upload_time_iso_8601": "2023-04-17T18:19:21.782864Z",
"url": "https://files.pythonhosted.org/packages/9d/3e/25e6927a82929b9b05f9b4abb7bebd6cd04ec8ba9231ce79b190ae3eb40b/pygtkspellcheck-5.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3586b2b69f35ddbbc67420823b2819e7a820ae5b8114138d365e536d93b01897",
"md5": "fb7dd2198c52dcbfe344aa5143b7277d",
"sha256": "ad657f821a0c587380993f1a6e5c0e8c948486dbcfa93fd47686415cbe4d8f4b"
},
"downloads": -1,
"filename": "pygtkspellcheck-5.0.2.tar.gz",
"has_sig": false,
"md5_digest": "fb7dd2198c52dcbfe344aa5143b7277d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 45545,
"upload_time": "2023-04-17T18:19:23",
"upload_time_iso_8601": "2023-04-17T18:19:23.600260Z",
"url": "https://files.pythonhosted.org/packages/35/86/b2b69f35ddbbc67420823b2819e7a820ae5b8114138d365e536d93b01897/pygtkspellcheck-5.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-17 18:19:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "koehlma",
"github_project": "pygtkspellcheck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pygtkspellcheck"
}
JSON
