Metadata-Version: 1.0
Name: python-usernames
Version: 0.1.3
Summary: Python library to validate usernames suitable for use in public facing applications.
Home-page: http://github.com/theskumar/python-usernames
Author: Saurabh Kumar
Author-email: me+github@saurabh-kumar.com
License: MIT
Description: python-usernames
        ================
        
        |Build Status| |Coverage Status| |PyPI version| |PyPI|
        
        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 2.6, 2.7, 3.3, 3.4
        
        Installation
        ------------
        
        ::
        
            pip install python-usernames
        
        Usages
        ------
        
        .. code:: python
        
            from 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:
        
        -  ``regex``: regular expression string that must pass before the banned
           words is checked. Default is ``^[a-zA-Z0-9_.-]+$``
        -  ``whitelist``: a list of words that should be considered as always
           safe.
        -  ``blacklist``: a list of words that should be considered as unsafe.
        
        License
        -------
        
        MIT
        
        .. |Build Status| image:: https://travis-ci.org/theskumar/python-usernames.svg?branch=v0.1.0
           :target: https://travis-ci.org/theskumar/python-usernames
        .. |Coverage Status| image:: https://coveralls.io/repos/theskumar/python-usernames/badge.svg?branch=master&service=github
           :target: https://coveralls.io/github/theskumar/python-usernames?branch=master
        .. |PyPI version| image:: https://badge.fury.io/py/python-usernames.svg
           :target: http://badge.fury.io/py/python-usernames
        .. |PyPI| image:: https://img.shields.io/pypi/dm/python-usernames.svg
           :target: https://pypi.python.org/pypi/python-usernames
        
Keywords: username,validation,registration,python,safe,signup
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Utilities
