hibpwned

1.3.9last stable release 8 months ago
Complexity Score
Low
Open Issues
0
Dependent Projects
0
Weekly Downloadsglobal
403

Downloads

Readme

hibpwned

A friendly, low-level, fully functional, Python API wrapper for haveibeenpwned.com
All data sourced from https://haveibeenpwned.com
Visit https://haveibeenpwned.com/API/v3 to read the Acceptable Use Policy
for rules regarding acceptable usage of this API.

Installation

pip install hibpwned

Making calls to the HIBP API requires a key. You can purchase an HIBP-API-Key at
https://haveibeenpwned.com/API/Key

Usage

This module contains the class Pwned with functions:

search_all_breaches
all_breaches
single_breach
data_classes
search_pastes
search_password
search_hashes

All functions return a list of JSON objects containing relevent data, with the exception
of search_password and search_hashes, which returns an integer and a string object,
respectively.

See module DocStrings for function descriptions and parameters

Examples

import hibpwned

my_app = hibpwned.Pwned("test@example.com", "My_App", "My_API_Key")

my_breaches = my_app.search_all_breaches()
breaches = my_app.all_breaches()
adobe = my_app.single_breach("adobe")
data = my_app.data_classes()
my_pastes = my_app.search_pastes()
password = my_app.search_password("BadPassword")
my_hashes = my_app.search_hashes("21BD1")

Dependencies

Loading dependencies...

CVE IssuesActive
0
Scorecards Score
4.00
Test Coverage
97.00%
Follows Semver
Yes
Github Stars
36
Dependenciestotal
1
DependenciesOutdated
0
DependenciesDeprecated
0
Threat Modelling
No
Repo Audits
No

Learn how to distribute hibpwned in your own private PyPI registry

pip install hibpwned
Processing...
Done

26 Releases

PyPI on Cloudsmith

Getting started with PyPI on Cloudsmith is fast and easy.