Wrapper for the Petfinder API
Project description
Petpy - Python Wrapper for the Petfinder API
Petpy is an easy-to-use and convenient Python wrapper for the Petfinder API.
Example
After receiving an API key from Petfinder, usage of petpy to extract data from the Petfinder database is straightforward.
import petpy
pf = petpy.Petfinder(key) # create connection to Petfinder API
cats = pf.breed_list('cat') # return all the listed cats breeds on the Petfinder website in JSON format
# The following returns the first 1,000 cat records in Washington in the Petfinder database as a pandas DataFrame.
cats_wa = pf.pet_find(location='WA', animal='cat', count=1000, return_df=True)
pf.pet_getRandom() # return a random pet record
Available Methods
Below is a summary table of the available methods in the petpy library and the accompanying Petfinder API method, as
well as a brief description. Please see the petpy documentation for more information on each method. The Petfinder
API methods documentation can also be found here. All
functions have a return_df parameter that when set to True, returns a pandas DataFrame of the results to facilitate
more efficient data analysis.
| Method | Petfinder API Method | Description |
|---|---|---|
| breed_list() | breed.list | Returns the available breeds for the selected animal. |
| pet_find() | pet.find | Returns a collection of pet records matching input parameters. |
| pet_get() | pet.get | Returns a single record for a pet. |
| pet_get_random() | pet.getRandom | Returns a randomly selected pet record. The possible result can be filtered with input parameters. |
| shelter_find() | shelter.find | Returns a collection of shelter records matching input parameters. |
| shelter_get() | shelter.get | Returns a single shelter record. |
| shelter_get_pets() | shelter.getPets | Returns a collection of pet records for an individual shelter. |
| shelter_list_by_breed() | shelter.listByBreed | Returns a list of shelter IDs listing animals matching the input animal breed. |
Documentation
Vignettes and Introduction to petpy
A series of IPython notebooks that introduce and explore some of the functionality and possible uses of the
petpy library. The notebooks can also be launched interactively with binder by clicking the
"launch binder" badge.
Installation
Petpy is easily installed through pip.
pip install petpy
Requirements
- Python 2.7 or Python >= 3.3
- requests >= 2.18.4
- Although not strictly required for installation, the pandas library is needed for returning the results as a DataFrame.
License
MIT
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for petpy-1.7.2-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 88799d5c40399deb9d5a165d05eb5808f31f812cfd8feaba6db8830476bf71fc |
|
| MD5 | 09a53f1c7ed48230e37b637949dccb80 |
|
| BLAKE2b-256 | 70ceb3af0e4fa03f2a5459377e254374f0e816d7e06ff0cb6727367dffa46bc8 |
