Metadata-Version: 1.1
Name: prof-checker
Version: 1.0.0
Summary: Wrapper for profanity checker that can work on python services/scripts, similar to linters (e.g. pylint)
Home-page: https://github.com/ozychhi/prof-checker
Author: Tornike Gogniashvili
Author-email: t.gogniashvili@gmail.com
License: UNKNOWN
Description: # pro-checker
        
        [![Build Status](https://travis-ci.com/ozychhi/prof-checker.svg?branch=master)](https://travis-ci.com/ozychhi/prof-checker)
        
        
        ## Prof-checker
        
        This is wrapper over [profanity-check](https://github.com/vzhou842/profanity-check/) by [vzhou842](https://github.com/vzhou842)
        
        `prof-checker` is meant to work the same way as other python linters work. Depending on how big your codebase
        is, it might take quite a bit of time to run this. I would not recommend running it on every PR.
        
        
        ## Installation
        
        ```
        $ pip install prof_checker
        ```
        
        ## Rough benchmarks
        
        As this is wrapper around `profanity-check` the performance greatly depends on the package. These benchmarks
        are only rought estimates.
        
        | Files | LoC | Time (ms)
        | --------|-------------------|---------------------
        | 500 | 250K | 7230
        | 22 | 4.3K | 1200
        | 70 | 20.6K | 1510
        
        ## Usage
        
        For help
        ```
        prof_checker -h
        ```
        
        To check `test.py`:
        ```
        prof_checker test.py
        ```
        
        To check all files in directory:
        ```
        find . -name \*.py | xargs prof_checker
        ```
        
        To override threshold:
        ```
        prof_checker -P 0.5 test.py
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
