ben174 / profanity

A Python library to check for (and clean) profanity in strings.

profanity

A Python library to check for (and clean) profanity in strings.

![Q-Bert spitting some profanity][logo] [logo]: http://i.imgur.com/kmz4Qx7.png

##Installation pip install profanity

##Usage from profanity import profanity profanity.contains_profanity("You smell like shit.") Out: True

profanity.censor("You smell like shit.")
Out: 'You smell like !@#$.'

# load my own custom bad words
custom_badwords = ['happy', 'jolly', 'merry']                           
profanity.load_words(custom_badwords)

profanity.contains_profanity("Have a merry day! :)")
Out: True

Features

• Load your own wordlist, or use the bundled one.
• Censors words using standard censor characters (!@#$%), or load your own censor characters.
• Uses a pool of censor characters to create a more natural censor string.
• Censors all instances of a given word with the same censor string - for easy correlation.

#TODO

• Support for whole words vs. partial words
• Regex support

I love Forks, Pull Requests, and Bugs!

I wrote this to satisfy my needs. Please feel free to contribute if you have other needs that you think others would benefit from!

Feel free to contact me: http://www.bugben.com

profanity's Issues

Should not flag bad words that are inside a larger word.

Don't change assassin to ******in.

ImportError: cannot import name profanity

When I install the library via pip and then try to implement the library to my problem I have an error

Traceback (most recent call last):
  File "/home/buzyarsest/Downloads/training.dev/ipnd/profanity.py", line 1, in <module>
    from profanity import profanity
  File "/home/buzyarsest/Downloads/training.dev/ipnd/profanity.py", line 1, in <module>
    from profanity import profanity
ImportError: cannot import name profanity

Great library by the way