https://github.com/reconcubed/django-profanity-filter

Django profanity template filter and validators
https://github.com/reconcubed/django-profanity-filter

django filter filters jinja2 profanity python swearing tags template

Last synced: 3 months ago
JSON representation

Django profanity template filter and validators

• Host: GitHub
• URL: https://github.com/reconcubed/django-profanity-filter
• Owner: ReconCubed
• License: bsd-3-clause
• Created: 2018-05-06T04:34:47.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-07T09:27:22.000Z (almost 7 years ago)
• Last Synced: 2024-11-03T22:48:48.557Z (3 months ago)
• Topics: django, filter, filters, jinja2, profanity, python, swearing, tags, template
• Language: Python
• Size: 17.6 KB
• Stars: 17
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django Profanity Filter

[![PyPI license](https://img.shields.io/pypi/l/django-profanity-filter.svg)](https://pypi.python.org/pypi/django-profanity-filter/) ![PyPI](https://img.shields.io/pypi/v/django-profanity-filter.svg) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-profanity-filter.svg) ![PyPI - Django Version](https://img.shields.io/pypi/djversions/django-profanity-filter.svg) [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)

Django Profanity Filter is a simple Django app that introduces a range of template tags and filters and model validators that remove or censor inappropriate language. 

## Installation

1. Install via pip

```

$ pip install django-profanity-filter

```

2. Add `'profanity',` to your `INSTALLED_APPS` in `settings.py`

```python

INSTALLED_APPS = (

...

'profanity',

...

)

```

## Usage

#### Template Tags

At the top of every template you wish to use profanity filters and tags on, make sure to load the profanity tags.

```jinja2

...

{% load profanity %}

...

```

##### Censor Filter

###### Example

```jinja2

{% with string='You are a bitch!' %}

{{ string|censor }}

{% endwith %}

```

The output will be `You are a *****!`, instead of `You are a bitch!`.

##### Is Profane Tag

###### Example

```jinja2

{% with string='You are a bitch!' %}

{{ string|is_profane }}

{% endwith %}

```

The output will be `True`, since the string contains profanity.

#### Validators

##### Is Profane Validator

###### Example

```python

from profanity.validators import validate_is_profane

class Post(models.Model):

    post = models.TextArea(max_length=150, validators=[validate_is_profane])

```

## TODO

### Template Tags

- [x] Basic filter

- [ ] Advanced filter

    - Keyword argument for custom word filter

    

### Validators

- [x] Basic Censorship Validator