chkpy 1.0.0

Wrapper for 3 python tools to aid in code development

ChkPy!

   ChkPy! is a wrapper for 3 python development tools, pylint, pycodestyle & auopep8.

Pylint provides syntax-error reporting, pycodestyle provides styling reporting & auopep8 provides enforcement of both.

ChkPy! also has 3 options. these modes/options are explained below in detail.

How to install ChkPy!

1. Make sure pip is installed

2. Install with command:

pip install chkpy

How to use ChkPy!

1. Open your terminal

2. Make sure your current directory is correct

3. Type "chkpy (filename/directory) (-options)  

ChkPy!'s 3 Options:

    - The default or " " which runs reporting tools before and after attempting to fix styling/syntax 
      (Before and after mode)
    
    - The "-r" option which only runs reporting tools against the given file/directory 
      (reporting mode)

    - The "-d" option which runs reporting tools AFTER attempting to fix styling/syntax 
      (devleoper mode)

Example(s)

    - chkpy Filename  (-r or -d ) 

    - chkpy Directory  (-r or -d )

ChkPy will allow you to run BOTH modes simultaneously. THIS IS NOT RECOMENDED. DO NOT DO THIS.

    Created by Anthony Clark, Dylan Haus & Nick Cardin