Skip to main content

A simple but quite powerful spellchecking library for GTK written in pure Python.

Project description

Python GTK Spellcheck

PyPi Project Page Documentation

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 and it supports both GTK 3 and 4 via PyGObject.

⚡️ News: Thanks to @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 for GtkTextView
  • support for word, line, and multiline ignore regular expressions
  • support for both GTK 3 and 4 via PyGObject for Python 3
  • configurable extra word characters such as '
  • localized names of the available languages based on ISO-Codes
  • support for custom ignore tags and hot swap of GtkTextBuffer
  • support for Hunspell (LibreOffice) and Aspell (GNU) dictionaries

Screenshot

🚀 Getting Started

Python GTK Spellcheck is available from the Python Package Index:

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 package.

🥳 Showcase

Over time, several projects have used Python GTK Spellcheck or are still using it. Among those are:

  • Nested Editor: “Specialized editor for structured documents.”
  • Cherry Tree: “A hierarchical note taking application, […].”
  • Zim: “Zim is a graphical text editor used to maintain a collection of wiki pages.”
  • REMARKABLE: “The best markdown editor for Linux and Windows.”
  • RedNotebook: “RedNotebook is a modern journal.”
  • Reportbug: “Reports bugs in the Debian distribution.”
  • UberWriter: “UberWriter is a writing application for markdown.”
  • Gourmet: “Gourmet Recipe Manager is a manager, editor, and organizer for recipes.“

🔖 Versions

Version numbers follow Semantic Versioning. 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.

🏗 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 outlining your idea.

By submitting a PR, you agree to license your contributions under “GPLv3 or later”.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygtkspellcheck-5.0.3.tar.gz (45.6 kB view details)

Uploaded Source

Built Distribution

pygtkspellcheck-5.0.3-py3-none-any.whl (46.3 kB view details)

Uploaded Python 3

File details

Details for the file pygtkspellcheck-5.0.3.tar.gz.

File metadata

  • Download URL: pygtkspellcheck-5.0.3.tar.gz
  • Upload date:
  • Size: 45.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.0 Darwin/23.1.0

File hashes

Hashes for pygtkspellcheck-5.0.3.tar.gz
Algorithm Hash digest
SHA256 3736b145753705321c44ef67a3011a93e564f97630f27042b1397ffdefea83ac
MD5 3703a827cb4dc30b5d36440db2aa061a
BLAKE2b-256 f2c12aa833d3bd77876bc895b8439a3353b2c822471881c5553d2e2252028339

See more details on using hashes here.

File details

Details for the file pygtkspellcheck-5.0.3-py3-none-any.whl.

File metadata

  • Download URL: pygtkspellcheck-5.0.3-py3-none-any.whl
  • Upload date:
  • Size: 46.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.0 Darwin/23.1.0

File hashes

Hashes for pygtkspellcheck-5.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5bd6fb3bdfcb3ce13825535ba6f1dc5d2e07a3e5d87d3034d8478d8bc884902c
MD5 283efffb8336f8a32781bdf7fbacee0f
BLAKE2b-256 85d4610e9b4be60bac8f5a155a9553a982c3462a6b3eb117e9903f59e9389fac

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page