Skip to main content

Fixes typos in text using regular expressions, based on RegExTypoFix from Wikipedia

Project description

Topy (anagram of “typo”) is a Python script to fix typos in text, using rulesets developed by the RegExTypoFix project from Wikipedia. The English ruleset is included with Topy and is used by default. Other rulesets can be manually downloaded.

Topy works with either Python 2 or 3.

The easiest way to install it is using pip:

pip install topy

Usage:

Usage: topy [options] FILES/DIRS...

Options:
  -h, --help            show this help message and exit
  -q, --quiet           silence information messages
  -a, --apply           overwrite files in place
  -r FILE, --rules=FILE
                        specify custom ruleset file to use

Resources

Contributing

Code style:

  • In general follow the Python PEP-8 coding style, except line length can go up to 120 chars.

  • Strings that have meaning for humans use double quotes ("), otherwise single quotes ('). When in doubt, don’t worry about it.

  • Code should be compatible with both Python 2 and 3, preferably without version-specific conditionals.

Run the test suite using python setup.py test.

Submit your changes as pull requests on GitHub.

License

The Topy software is licensed under the MIT license (see LICENSE.txt)

The bundled retf.txt file, copied from Wikipedia:AutoWikiBrowser/Typos by Wikipedia contributors is licensed under CC-BY-SA. See the page on Wikipedia for authorship information.

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

topy-0.1.0.tar.gz (112.3 kB view details)

Uploaded Source

File details

Details for the file topy-0.1.0.tar.gz.

File metadata

  • Download URL: topy-0.1.0.tar.gz
  • Upload date:
  • Size: 112.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for topy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 22ac2cf351359a3af37f2d78c645b030cc66f33bad33ce010451388c1a4a3053
MD5 f101634128a7b1141539a2ce46eb85d8
BLAKE2b-256 11c7bbd736d46fd2a7b2fc05905870b7e9a1a4086d74b37468cf82d093b4ac08

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