Skip to content
/ topy Public
forked from intgr/topy

Python script to fix typos in text, based on the RegExTypoFix project from Wikipedia and AutoWikiBrowser

License

Notifications You must be signed in to change notification settings

tomron/topy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Topy

Travis CI

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.

About

Python script to fix typos in text, based on the RegExTypoFix project from Wikipedia and AutoWikiBrowser

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.1%
  • Shell 0.9%