Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A universal Python library for detecting and/or filtering profane words.

Project Description
# profanityfilter
[![Build Status](https://travis-ci.org/areebbeigh/profanityfilter.svg?branch=master)](https://travis-ci.org/areebbeigh/profanityfilter)

A universal Python library for detecting and/or filtering profane words.

<img src="https://pixabay.com/static/uploads/photo/2014/03/24/13/47/swearing-294391_960_720.png" height="300px" width="250px">

<b>PyPI:</b> https://pypi.python.org/pypi/profanityfilter<br>
<b>Doc:</b> http://pythonhosted.org/profanityfilter

# Installation

`> pip install profanityfilter`

# Usage

```
import profanityfilter
profanityfilter.censor("That's bullshit!")
> "That's ********!"
profanityfilter.set_censor("@")
profanityfilter.censor("That's bullshit!")
> "That's @@@@@@@@!"
profanityfilter.define_words(["icecream", "choco"])
profanityfilter.censor("I love icecream and choco!")
> "I love ******** and *****"
profanityfilter.is_clean("That's awesome!")
> True
profanityfilter.is_clean("That's bullshit!")
> False
profanityfilter.is_profane("Profane shit is not good")
> True
```

# Console Executable

```
profanityfilter -h
> usage: profanityfilter-script.py [-h] [-t TEXT | -f PATH] [-o OUTPUT_FILE]
> [--show]
>
> Profanity filter console utility
>
> optional arguments:
> -h, --help show this help message and exit
> -t TEXT, --text TEXT Test the given text for profanity
> -f PATH, --file PATH Test the given file for profanity
> -o OUTPUT_FILE, --output OUTPUT_FILE
> Write the censored output to a file
> --show Print the censored text
```

# Contributing
I encourage you to fork this repo and expand it in anyway you like. Pull requests are welcomed!

# Additional Info
Developer: Areeb Beigh <areebbeigh@gmail.com><br>
GitHub Repo: https://github.com/areebbeigh/profanityfilter/
Release History

Release History

This version
History Node

1.1.2

History Node

1.1.1

History Node

1.1

History Node

1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
profanityfilter-1.1.2-py2.py3-none-any.whl (6.1 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Jun 9, 2017
profanityfilter-1.1.2.zip (8.8 kB) Copy SHA256 Checksum SHA256 Source Jun 9, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting