CenSwear

CenSwear is a Python based profanity filter API. CenSwear is a simple, free, and reliable language understanding API designed to recognize and remove profanity, obscenity, and other unwanted text. It’s a technology you can swear by!

Check out the live site - CenSwear

How it works

How to use

• Python
  

Built With:

Software/ Language	Version
Python	3.8
Flask	2.0.0

Features:

• Profanity detection and filtering from texts

  • The API detects and censors swear words and profanities from chat and text messages based on an internal profanity list.

• Multilingual

  • We’ve designed CenSwear in a way that it detetcts profanities in multiple languages

• Real-time censoring of expletives

  • The web service also provides real-time redaction of swear words while emails and documents are being typed.

• Fast, accurate, reliable

  • CenSwear ensures that not one single offensive message slips through its filters, creating a safe and productive environment for the users.

Project Organization

├── README.md          <- The top-level README for developers using this project.
│
├── requirements.txt   <- The requirements file for reproducing the environment
│
├── test
│  └── app_test.py     <- The python script for testing the app
│
├── LICENSE
│
├── Procfile           <- for heroku deployment
│
└── src
    ├── __init__.py 
    ├── app.py         <- Main python file containig the flask app
    ├── templates
    │   ├── base.html
    │   └── home.html
    └── static
        ├── assets     <- contains svg images and backgrounds 
        └── css        <- The css files for the web app

How to get started

To use this project, follow these steps:

• Make a .env file having same structure as .env.sample inside the src folder
• Fill in the FILTER_WORDLIST_URL and CLEAN_WORDLIST_URL variables
• Clone this repository

git clone https://github.com/MLSA-SRM/CenSwear.git

• Install dependencies

pip install -r requirements.txt

• Go to the app root folder

cd src

• Run the App python app.py or flask run

Contributors:

Ayush Mishra

Shreyas

Manu

Pallavi Pandey

Priyanshi David

Sahil