Skip to main content

Validate usernames against a blacklist

Project description

Build Status PyPI version

The-Big-Username-Blacklist-Python

This library lets you validate usernames against a blacklist. The blacklist data is based on the data from The-Big-Username-Blacklist and contains privilege, programming terms, section names, financial terms and actions.

You can try the blacklist using the tool Username checker.

How it works

the_big_username_blacklist exposes a function named validate, you can use that function to see if a word is occuring in the blacklist.

Usage

Validating a username is easy, if the word is in the blacklist, return False (validation failed), otherwise True. Example:

>>>> from the_big_username_blacklist import validate
>>>> validate("root")
False
>>>> validate("martin")
True

Access the blacklist

If you only want to retrive the blacklist data, you can find it in the list property.

>>>> from the_big_username_blacklist import get_blacklist
>>>> get_blacklist()
[ '400',
  '401',
  '403'...

Installation

This package is available through pip

$ pip install the-big-username-blacklist

Tests

Make sure you have the necessary dependencies (pytest)

pip install -r requirements/tests.txt

Then run the tests

py.test tests

Contributing

Want to contribute? Awesome. Just send a pull request.

License

The-Big-Username-Blacklist-Python is released under the MIT License.

Project details


Download files

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

Files for the_big_username_blacklist, version 1.5.4
Filename, size File type Python version Upload date Hashes
Filename, size the_big_username_blacklist-1.5.4.tar.gz (5.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page