An open API service indexing awesome lists of open source software.

https://github.com/profanitas/abuse

World's First Profanity Library.
https://github.com/profanitas/abuse

abuse library pip profanity profanity-library pypi pypi-packages python python3

Last synced: 14 days ago
JSON representation

World's First Profanity Library.

Awesome Lists containing this project

README

        

# Abuse: World's First Profanity Library

> Abuse is in it's beta.

[![PyPI Download/Month](https://img.shields.io/pypi/dm/abuse.svg)](https://pypi.python.org/pypi/abuse/)
[![PyPI Version](https://img.shields.io/pypi/v/abuse.svg)](https://pypi.python.org/pypi/abuse/)
[![PyPI license](https://img.shields.io/pypi/l/abuse.svg)](https://pypi.python.org/pypi/abuse/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/abuse.svg)](https://pypi.python.org/pypi/abuse/)
[![PyPI implementation](https://img.shields.io/pypi/implementation/abuse.svg)](https://pypi.python.org/pypi/abuse/)
[![GitHub contributors](https://img.shields.io/github/contributors/0x48piraj/abuse.svg)](https://GitHub.com/0x48piraj/abuse/graphs/contributors/)
[![HitCount](http://hits.dwyl.io/0x48piraj/abuse.svg)](http://hits.dwyl.io/0x48piraj/abuse)

[![forthebadge: F** It! Ship It!](https://forthebadge.com/images/badges/fuck-it-ship-it.svg)](https://forthebadge.com) [![forthebadge: Made With Python](https://forthebadge.com/images/badges/made-with-python.svg)](https://forthebadge.com) [![forthebadge: Kinda Safe For Work](https://forthebadge.com/images/badges/kinda-sfw.svg)](https://forthebadge.com) [![forthebadge: Creative Commons - Non-Commercial - Sharealike](https://forthebadge.com/images/badges/cc-nc-sa.svg)](https://forthebadge.com)

![Logo by Manav Kapil](https://i.imgur.com/lxNi789.png)

> This logo was created by my friend, **Manav Kapil**. Have a look at his [Behance Profile](https://www.behance.net/manavkapil1999)!

### Behold, the power of Abuse

**Abuse** allows you to use profanity when you need it, without the need for getting angry. There's no need to manually search curse words from **Google**, or to ask anybody. Abuse is 100% automatic, thanks to Python.

It's available over Python Package Installer as **[PyPI/abuse](https://pypi.org/project/abuse/)**

Besides, all the cool kids are doing it. You should try it!

#### Let's import the beast

```
>>>import abuse as ab
>>>ab.list_from("a")

['...', '...', '...'] # gives a nice list of profane words starting with the letter 'a'
```

# Usage

- `list_from('letter')` : Returns list of abuses starting from a specific letter.
- `random_from('letter')` : Returns a random abuse starting from a specific letter.
- `random()` : Returns any random profane word from it's built-in dataset.
- `list_all()` : Returns list of profane words in it's database.

# Compatibility

_Abuse officially supports Python 3.4 to 3.7, but can also run on Python 2.*_

# Installation

To install Abuse, simply use pipenv _(or pip, of course)_:

```
$ pip install abuse
$ pipenv install abuse
C:\Python34\Scripts> pip install abuse
C:\> py -3 -m pip install abuse
```

**Satisfaction guaranteed.**

# Documentation
Fantastic documentation will be available in some days, for a limited time only.