Skip to main content

Package for checking text for existance of blacklisted or whitelisted words

Project description

checkword

Simple module for check if the text contains blacklisted or whitelisted words

Installation

pip install checkword

Usage

import checkword

# add some bad words to blacklist
checkword.add_bad_words(['some', 'bad', 'words', 'like', 'sheet'])

# and good words
checkword.add_good_words(['Festival', 'Event', 'Holiday'])

print(checkword.blacklisted('My some text to check for bad words'))
# True

print(checkword.whitelisted('Another text to check for good words'))
# False

Methods

add_bad_words(words)

add word or words list/tuple to blacklist

add_good_words(words)

add word or words list/tuple to whitelist

blacklisted(text, match_case=False, words=True)

check if text contains any bad words
text: text for checking
match_case: use case sensitive word matching. if True checkword.blacklisted('bAd') will be False when 'bad' is in blacklist
words: match only complete words. if True checkword.blacklisted('my bad string')=True and checkword.blacklisted('mybadstring')=False while 'bad' is in blacklist

whitelisted(text, match_case=False, words=True)

check if text contains any whitelisted words
text: text for checking
match_case: use case sensitive word matching. if True checkword.whitelisted('gOoD') will be False when 'good' is in blacklist
words: match only complete words. if True checkword.whitelisted('my good string')=True and checkword.whitelisted('mygoodstring')=False while 'good' is in blacklist

remove_bad_word(word)

remove bad word from blacklist

remove_good_word(word)

remove good word from whitelist

clear_blacklist()

remove all bad words from blacklist

clear_whitelist()

remove all good words from whitelist

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for checkword, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size checkword-0.0.3-py3-none-any.whl (3.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size checkword-0.0.3.tar.gz (2.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page