Metadata-Version: 1.1
Name: profanityfilter
Version: 1.1
Summary: A Python library for detecting and/or filtering profane words.
Home-page: https://github.com/areebbeigh/profanityfilter
Author: Areeb Beigh
Author-email: areebbeigh@gmail.com
License: BSD
Description: # profanityfilter
        A universal Python library for detecting and/or filtering profane words.
        
        <img src="https://pixabay.com/static/uploads/photo/2014/03/24/13/47/swearing-294391_960_720.png" height="300px" width="250px">
        
        <b>PyPI:</b> https://pypi.python.org/pypi/profanityfilter<br>
        <b>Doc:</b> http://pythonhosted.org/profanityfilter
        
        # Installation
        
        `> pip install profanityfilter`
        
        # Usage
        
        ```
        import profanityfilter
        profanityfilter.censor("That's bullshit!")
        > "That's bull****!"
        profanityfilter.set_censor("@")
        profanityfilter.censor("That's bullshit!")
        > "That's bull@@@@!"
        profanityfilter.define_words(["icecream", "choco"])
        profanityfilter.censor("I love icecream and choco!")
        > "I love ******** and *****"
        profanityfilter.is_clean("That's awesome!")
        > True
        profanityfilter.is_clean("That's bullshit!")
        > False
        profanityfilter.is_profane("Profane shit is not good")
        > True
        ```
        
        # Console Executable
        
        ```
        profanityfilter -h
        > usage: profanityfilter-script.py [-h] [-t TEXT | -f PATH] [-o OUTPUT_FILE]
        >                                  [--show]
        >
        > Profanity filter console utility
        >
        > optional arguments:
        >   -h, --help            show this help message and exit
        >   -t TEXT, --text TEXT  Test the given text for profanity
        >   -f PATH, --file PATH  Test the given file for profanity
        >   -o OUTPUT_FILE, --output OUTPUT_FILE
        >                         Write the censored output to a file
        >   --show                Print the censored text
        ```
        
        # Contributing
        I encourage you to fork this repo and expand it in anyway you like. Pull requests are welcomed!
        
        # Additional Info
        Developer: Areeb Beigh <areebbeigh@gmail.com><br>
        GitHub Repo: https://github.com/areebbeigh/profanityfilter/
Keywords: profanity filter clean content
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
