filter-profanity
filter-profanity
is one of the most efficient python packages that provides functionality to censor profanity in text! The package cross-verifies text with a list of opensource profane vocabulary that you can find here.
This package can be used in many areas including chat applications, bots and anything that handles user input!
Thanks to @itsmewulf and @Sh-wayz for contributing to the development of this project!
Sidetrack - A little about me
I'm a 13 year old full-stack web developer and I love working with Python, NodeJS, SQL
and other cool software! I want to make a positive change with the help of software and
do some cool stuff as I grow. That's just a little about me, back to the package!
Installation
Installing filter-profanity
is as easy as running pip install filter-profanity
!
Usage
We've developed filter-profanity
to make it as easy as possible to utilize.
Currently, filter-profanity
provides three functions - censor_profanity
, has_profanity
and get_profanity
censor_profanity(text, optional_censor)
takes in two arguments, the text that it scans for profanity and an optional censor to replace profane language with. If you do not provide a censor, we default to *
. Here's an example -
from profanity import censor_profanity
print(censor_profanity("This code is definitely not sh!t"))
# Prints -
# This code is definitely not ****
has_profanity(text)
takes in one argument- the text that it must check for profanity. If the provided text has any profane content, it returns True
otherwise it conditionally returns False
. Here's an example -
from profanity import has_profanity
print(has_profanity("This code is definitely not sh!t"))
# Prints -
# True
get_profanity(text, duplicates=False)
takes two arguments - the text to return profanity from, and a boolean specifying if it should return duplicate words or not (defaults to False). If the text has any profane content, it returns a list with detected words, otherwise it returns an empty list. Here's an example -
from profanity import get_profanity
print(get_profanity("This code is definitely not sh!t sh!t"))
# Prints -
# ['sh!t']
Contributing
This package is opensource so anyone with adequate python experience can contribute to this project!
Report Issues
If you find any error/bug/mistake with the package or in the code feel free to create an issue and report it here
Fix/Edit Content
If you want to contribute to this package, fork the repository, clone it, make your changes and then proceed to create a pull request here
Contact
If you want to contact me -
Mail - trustedmercury@gmail.com
Discord - TrustedMercury#2007