Metadata-Version: 2.1
Name: pwnedapi
Version: 1.0.0
Summary: Library for easily interfacing with Have I Been Pwned API v2.
Home-page: https://github.com/nikoheikkila/pwnedapi
Author: Niko Heikkilä
Author-email: yo@nikoheikkila.fi
License: MIT
Description: 
        # `pwnedapi` (Have I Been Pwned)
        
        [![Codacy grade](https://img.shields.io/codacy/grade/c08d3ae2b32f4f4e939765eda3608d8f.svg?style=for-the-badge)](https://app.codacy.com/project/nikoheikkila/pwnedapi/dashboard)
        [![Travis (.org)](https://img.shields.io/travis/nikoheikkila/pwnedapi.svg?style=for-the-badge)](https://travis-ci.org/nikoheikkila/pwnedapi)
        [![Codecov](https://img.shields.io/codecov/c/github/nikoheikkila/pwnedapi.svg?style=for-the-badge)](https://codecov.io/gh/nikoheikkila/pwnedapi)
        [![PyPI](https://img.shields.io/pypi/v/pwnedapi.svg?style=for-the-badge)](https://pypi.org/project/pwnedapi/)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/pwnedapi.svg?style=for-the-badge)](https://pypi.org/project/pwnedapi/)
        [![Read the Docs](https://img.shields.io/readthedocs/pwnedapi.svg?style=for-the-badge)](https://pwnedapi.readthedocs.io/en/latest/)
        [![GitHub](https://img.shields.io/github/license/nikoheikkila/pwnedapi.svg?style=for-the-badge)](LICENSE)
        [![Twitter Follow](https://img.shields.io/twitter/follow/nikoheikkila.svg?style=for-the-badge&label=Follow)](https://twitter.com/nikoheikkila)
        
        A Python library to leverage **Troy Hunt's** [_Have I Been Pwned API v2_][hibp]
        and the _k-Anonymity_ model. Inspired by **Phil Nash's** Ruby gem [_pwned_][pwned].
        
        Supported on Python versions 3.5 and up.
        
        ## Installation
        
        ```bash
        # Option 1: From the PyPI repository
        pip install pwnedapi
        
        # Option 2: For people of great taste
        pipenv install pwnedapi
        
        # Option 3: Locally
        git clone https://github.com/nikoheikkila/pwnedapi
        cd pwnedapi
        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.
        
        ![Check a single password](docs/check.png)
        
        You can also scan a file of passwords, and export results in any format
        supported by the [`tablib`][tablib] library.
        
        ![Scan a file of passwords](docs/scan.png)
        
        ## CLI usage
        
        The library also installs a command-line tool which you can use to check
        your password from the comfort of your terminal. Run `pwned` to see all the possibilities.
        
        ## Development
        
        Clone the repository normally. Then run `make` to install the dependencies.
        
        While developing it's useful to ensure an acceptable code quality where the
        Pylama linter is helpful: run `make lint` to check your code. Once you have
        written your tests run `make test` to invoke the PyTest suites.
        
        To run tests and calculate the code coverage run `make coverage`. This command
        will fail if you haven't set up a Codecov project with `$CODECOV_TOKEN`
        variable.
        
        Remember to document your features and see that the documentation compiles
        successfully by running `make docs`.
        
        ## Contributing
        
        Check the source code and issues from this repository, and should anything
        interesting pop out feel free to open a pull request.
        
        Before your changes will be merged make sure that Travis CI pipeline is green
        and code coverage is on acceptable level. GitHub takes care of these
        eventually but to save time always consider running the tests locally before
        pushing.
        
        [hibp]: https://haveibeenpwned.com/API/v2#SearchingPwnedPasswordsByRange
        [pwned]: https://philnash.github.io/pwned/
        [tablib]: http://docs.python-tablib.org/en/latest/
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.5.0
Description-Content-Type: text/markdown
