README.rst

Python obscene words filter.

---

---

This is ultra simple words filter, based on regular expressions. It is built on regular expressions, with Russian language support out of the box.

Before using in production, you should test it, because there are no swear words filter in the world that does well filtering, so the quality is not 100%. But test coverage is :)

Also it can eat CPU.

Quickstart

Sample code:

from obscene_words_filter.default import get_default_filter

f = get_default_filter()

Or:

from obscene_words_filter import conf
from obscene_words_filter.words_filter import ObsceneWordsFilter

f = ObsceneWordsFilter(conf.bad_words_re, conf.good_words_re)

Then you can mask use input:

f.mask_bad_words("Тут должны быть матерные слова.")
>>> Тут должны быть ******** *****.

Documentation

Just read the tests :)