Skip to main content

A small module meant for use in text generators that lets you filter strings for bad words.

Project description

wordfilter

A small module meant for use in text generators. It lets you filter strings for bad words.

Getting Started

Install the module with: npm install wordfilter

var wordfilter = require('wordfilter');
wordfilter.blacklisted('does this string have a bad word in it?'); // "false"

// clear the list entirely
wordfilter.clearList();

// add new words
wordfilter.addWords(['zebra','elephant']);
wordfilter.blacklisted('this string has zebra in it'); // "true"

// remove a word
wordfilter.removeWord('zebra');
wordfilter.blacklisted('this string has zebra in it'); // "false"

Or with Python: Install the module with: pip install wordfilter

from wordfilter import Wordfilter
wordfilter = Wordfilter()
wordfilter.blacklisted('does this string have a bad word in it?')  # False

# clear the list entirely
wordfilter.clearList()

# add new words
wordfilter.addWords(['zebra','elephant'])
wordfilter.blacklisted('this string has zebra in it')  # True

Documentation

This is a word filter adapted from code that I use in a lot of my twitter bots. It is based on a list of words that I've hand-picked for exclusion from my bots: essentially, it's a list of things that I would not say myself. Generally speaking, they are "words of oppression", aka racist/sexist/ableist things that I would not say.

The list is not all-inclusive, and I'm always adding words to it. If you'd like to file an issue or a pull request to add more words, please do so, but understand that this is primarily for use in my own projects, and I may not agree to add certain words. (For example, I have no problem with scatological words, so "shit" and "fuck" will never be on this list.)

Words are case insensitive.

Also note that due to the complexities of the English language, I am considering anything containing the substring of a bad word to be blacklisted. For example, even though "homogenous" is not a bad word, it contains the substring "homo" and it gets filtered. The reason for this is that new slang pops up all the time using compound words and I can't possibly keep up with it. I'm willing to lose a few words like "homogenous" and "Pakistan" in order to avoid false negatives.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

Copyright (c) 2013 Darius Kazemi Licensed under the MIT license.

Project details


Download files

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

Source Distribution

wordfilter-0.2.7.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

wordfilter-0.2.7-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file wordfilter-0.2.7.tar.gz.

File metadata

  • Download URL: wordfilter-0.2.7.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.8

File hashes

Hashes for wordfilter-0.2.7.tar.gz
Algorithm Hash digest
SHA256 81b5d8077d1004d5a6fd56e02c506e93f49ef30920e235fa28ff7950a7b44c31
MD5 58b2ad5b141594ee825b466e65381cc7
BLAKE2b-256 40230674c5228f9f45079fa82821ec7861fb81c5d4943b73e2d58501595a9664

See more details on using hashes here.

File details

Details for the file wordfilter-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: wordfilter-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.8

File hashes

Hashes for wordfilter-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bca1959109fed57051e2484dc2b47f1f8b1d3241eaa6ea50a6151d19f2466638
MD5 d6309fc326520413af0ef830130dead5
BLAKE2b-256 ea695093450f36945ba1e06163a5cb3feb414468cf3fa25fb13ad6c06fa2064b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page