https://github.com/theskumar/python-usernames

Ensures usernames are url friendly. No abusive/reserved words.
https://github.com/theskumar/python-usernames

Last synced: 17 days ago
JSON representation

Ensures usernames are url friendly. No abusive/reserved words.

• Host: GitHub
• URL: https://github.com/theskumar/python-usernames
• Owner: theskumar
• Created: 2015-09-28T15:31:47.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2023-06-17T14:06:57.000Z (over 1 year ago)
• Last Synced: 2024-10-11T21:53:59.632Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 45.9 KB
• Stars: 100
• Watchers: 9
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# python-usernames

[![Build

Status](https://travis-ci.org/theskumar/python-usernames.svg?branch=v0.1.0)](https://travis-ci.org/theskumar/python-usernames)

[![Coverage

Status](https://coveralls.io/repos/theskumar/python-usernames/badge.svg?branch=master&service=github)](https://coveralls.io/github/theskumar/python-usernames?branch=master)

[![PyPI

version](https://badge.fury.io/py/python-usernames.svg)](http://badge.fury.io/py/python-usernames)

Python library to validate usernames suitable for use in public facing

applications where use can choose login names and sub-domains.

## Features

-   Provides a default regex validator

-   Validates against list of [banned

    words](https://github.com/theskumar/python-usernames/blob/master/usernames/reserved_words.py)

    that should not be used as username.

-   Python 3.8+

## Installation

    pip install python-usernames

## Usages

```python

from python_usernames import is_safe_username

>>> is_safe_username("jerk")

False  # contains one of the banned words

>>> is_safe_username("handsome!")

False  # contains non-url friendly `!`

```

**is\_safe\_username** takes the following optional arguments:

-   `whitelist`: a case insensitive list of words that should be

    considered as always safe. Default: `[]`

-   `blacklist`: a case insensitive list of words that should be

    considered as unsafe. Default: `[]`

-   `max_length`: specify the maximun character a username can have.

    Default: `None`

- `regex`: regular expression string that must pass before the banned

:   words is checked.

The default regular expression is as follows:

    ^                       # beginning of string

    (?!_$)                  # no only _

    (?![-.])                # no - or . at the beginning

    (?!.*[_.-]{2})          # no __ or _. or ._ or .. or -- inside

    [a-zA-Z0-9_.-]+         # allowed characters, atleast one must be present

    (?