Skip to main content

Python utility for Have I Been Pwned API

Project description

pypi version python application dependency review

hibp-py

hibp-py is a Python library that facilitates the analysis and tracking of breaches posted to haveibeenpwned.

Installation

  1. Install from pip: python -m pip install hibp-py

Basic Usage

$ python -m hibp_py -h
Welcome to HIBP Python!
usage: __main__.py [-h] [-iL INPUT_LIST] [-o OUTPUT] [-D ACTIVE_DIRECTORY] [-e EMAIL_CONFIG]

options:
  -h, --help            show this help message and exit
  -iL INPUT_LIST, --input-list INPUT_LIST
                        Input list of emails or haveibeenpwned JSON file
  -o OUTPUT, --output OUTPUT
                        Output file name
  -D ACTIVE_DIRECTORY, --active-directory ACTIVE_DIRECTORY
                        Active Directory domain
  -e EMAIL_CONFIG, --email-config EMAIL_CONFIG
                        Email configuration file

Contributing

If you'd like to contribute to the project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your changes: git checkout -b my-new-feature.
  3. Make your changes and commit them: git commit -am 'Add some feature'.
  4. Push to the branch: git push origin my-new-feature.
  5. Submit a pull request.

License

hibp-py is licensed under the MIT License. Feel free to use it for personal or commercial use.

Project details


Download files

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

Source Distribution

hibp_py-1.0.4.tar.gz (8.7 kB view hashes)

Uploaded Source

Built Distribution

hibp_py-1.0.4-py3-none-any.whl (7.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page