intgr / topy Goto Github PK

write encoding is not specified on "--apply" .
I guess f.write encoding should match to f.read :

   if opts.apply:
       log.info("Writing %s", safe_name)
       with open(filename, 'w', encoding='utf-8') as f:
           f.write(text)

Provide an option to explicitly exclude certain directories or files.

For example, with the structure:

project
|    README.md
|    somefile.txt
|___ first-dir
     |    file-to-check.txt    
     |    other-typo-file.txt
     |
     |___ exclude-dir
          | ...

If I want to search for typos in all the files in first-dir except for anything in exlude-dir, I would like to do something like
topy --exclude exclude-dir root-dir

Could this option be added to provide a little more flexibility with the tool? Thanks

I have installed topy and I keep getting the following error when I try to run "topy.exe c:\temp\typos.txt":

c:\PythonPortable\App\Scripts>topy.exe c:\temp\typos.txt
Traceback (most recent call last):
  File "c:\PythonPortable\App\Scripts\topy-script.py", line 5, in <module>
    from pkg_resources import load_entry_point
  File "c:\PythonPortable\App\lib\site-packages\pkg_resources.py", line 2603, in <module>
    working_set.require(__requires__)
  File "c:\PythonPortable\App\lib\site-packages\pkg_resources.py", line 666, in require
    needed = self.resolve(parse_requirements(requirements))
  File "c:\PythonPortable\App\lib\site-packages\pkg_resources.py", line 565, in resolve
    raise DistributionNotFound(req)  # XXX put more info here
pkg_resources.DistributionNotFound: beautifulsoup4

I tried on Linux too and got the same error.

This will make it easier to install and use for Python folks.

I have a very simple use case where topy fails on a YAML file by trying to add case:

- foo/jordan

Topy would rename jordan to Jordan, which will break the code as this is a filename.

Few problems related to this:

• topy does not mention which rules was used in this case
• topy has no command line parameter to enable more verbose mode (ex. to identify the rule used)
• no option to disable topy or rule per specific line, file or repository.

There is not a single example of usage in the README. I created a file with some text with typos:

# test.txt
Hellp, my name is not rekevant.

Then I ran the command as specified but got nothing.

$ topy test.txt
Loaded 3729 rules (except 0 errors, 44 disabled)

Did it work but couldn't find any typos? Or am I doing something wrong and it didn't run properly?

Add a flag or an option to do something similar to -

cat f | typo -s > new_file
typo -s <string> > new_file
use case -

1. Want to create a new file and not to override existing one
2. Get input from user and output it.

Parsing the ruleset tag soup file with BeautifulSoup4 can consume half a second at every startup; see issue #5.

Loading the regs everytime doesn't make sense.

Just keeping a list of known false positives for personal reference. Feel free to add comments here.

Topy replaces:

• attribtue -> attributue - both are incorrect :)
• 2014-11-01T12:00 -> 2014 and 2011-01T12:00
• From then on it's just like any exception -> From then on its just like any exception

This is somewhat related to #3, we can make the script run over entire directory or a specific file. Also the need for update.sh can be removed as it can be made just a function in the file

Add an option to run it case insensitive

Right now you have to do some bash-fu to run topy over every file, it'd be great if that was a builtin feature.