Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A Python client for the HaveIBeenPwned REST API

Project description

Copyright (c) 2015 Eric Fay @icanhasfay

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Description: PyPwned
======
[![Build Status](https://travis-ci.org/icanhasfay/PyPwned.svg)](https://travis-ci.org/icanhasfay/PyPwned)

A Python client for the HaveIBeenPwned REST API. https://haveibeenpwned.com/

Installation
-----
```pip install pypwned```

Requires
-----
* requests
* pyOpenSSL
* ndg-httpsclient
* pyasn1

Usage
-----

### Breaches


#### Getting all breaches for an account

##### Get all breaches for an account across all domains.

```
import pypwned
print pypwned.getAllBreachesForAccount(email="foo@bar.com")
```

##### Get all breaches for an account across a specific domain.

```
import pypwned
print pypwned.getAllBreachesForAccount(email="foo@bar.com",domain="adobe.com")
```


#### Getting all breached sites in the system

##### Return the details of each breach in the system.

```
import pypwned
print pypwned.getAllBreaches()
```

##### Return the details of each breach associated with a specific domain.

```
import pypwned
print pypwned.getAllBreaches(domain="adobe.com")
```

#### Getting a single breached site

Return the details of a single breach, by breach name.

```
import pypwned
print pypwned.getSingleBreachedSite(name="adobe")
```

#### Getting all data classes in the system

Return the different types of data classes that are associated with a record in a breach. E.G, Email addresses and passwords

```
import pypwned
print pypwned.getAllDataClasses()
```

### Pastes


#### Getting all pastes for an account

Return any pastes that contain the given email address

```
import pypwned
print pypwned.getAllPastesForAccount(account="foo@bar.com")
```




Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Topic :: Security

Project details


Download files

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

Files for pypwned, version 0.1.6
Filename, size File type Python version Upload date Hashes
Filename, size pypwned-0.1.6-py2-none-any.whl (5.6 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size pypwned-0.1.6.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page