Metadata-Version: 1.2
Name: pwnedapi
Version: 0.1
Summary: Library for easily interfacing with Have I Been Pwned API v2
Home-page: http://github.com/nikoheikkila/pwnedapi
Author: Niko Heikkilä
Author-email: yo@nikoheikkila.fi
License: MIT
Project-URL: Source Code, http://github.com/nikoheikkila/pwnedapi
Description: # `pwnedapi` (Have I Been Pwned)
        
        A small utility class to leverage Troy Hunt's [_Have I Been Pwned API v2_](https://haveibeenpwned.com/API/v2#SearchingPwnedPasswordsByRange) and the _k-Anonymity_ model. Inspired by Phil Nash's Ruby gem [_pwned_](https://philnash.github.io/pwned/).
        
        ## Installation
        
        ```bash
        python setup.py install
        ```
        
        ## Usage
        
        In its simplest form you'll only need to use two methods. Will probably add more if and when the API grows.
        
        ```python
        >>> from pwnedapi import Password
        >>> password = Password("mysupersecretpassword")
        >>>
        >>> if password.is_pwned():
        ...     print(f"Your password has been pwned {password.pwned_count} times.")
        ...
        Your password has been pwned 2 times.
        >>>
        ```
        
        ## Support
        
        This is my first official Python package so if something is off feel free to send a PR. :fist:
        
        # TODO
        
        - [ ] Add password change form validators to Django and Flask
Keywords: passwords,pwned,security
Platform: UNKNOWN
Requires-Python: >=3.6
