Petpy

Petpy is an easy-to-use and convenient Python wrapper for the Petfinder API. Includes methods for parsing output JSON into pandas DataFrames for easier data analysis

Installation

petpy is easily installed through pip.

pip install petpy

The library can also be cloned or downloaded into a location of your choosing and then installed using the setup.py
file per the following:

git clone [email protected]:aschleg/petpy.git
cd petpy
python setup.py install

Examples and usage

An account must first be created with Petfinder to receive an API and secret
key. The API and secret key will be used to grant access to the Petfinder API, which lasts for 3600 seconds, or one
hour. After the authentication period ends, you must re-authenticate with the Petfinder API. The following are some
quick examples for using petpy to get started. More in-depth tutorials for petpy and some examples of what
can be done with the library, please see the More Examples and Tutorials section below.

Authenticating with the Petfinder API

Authenticating the connection with the Petfinder API is done at the same time the Petfinder class is initialized.

pf = Petfinder(key=key, secret=secret)

The following are some quick examples for getting started with petpy and the Petfinder API.

Finding animal types

# All animal types and their relevant data.
all_types = pf.animal_types()

# Returning data for a single animal type
dogs = pf.animal_types('dog')

# Getting multiple animal types at once
cat_dog_rabbit_types = pf.animal_types(['cat', 'dog', 'rabbit'])

Getting animal breeds for available animal types

cat_breeds = pf.breeds('cat')
dog_breeds = pf.breeds('dog')

# All available breeds or multiple breeds can also be returned.

all_breeds = pf.breeds()
cat_dog_rabbit = pf.breeds(types=['cat', 'dog', 'rabbit'])

The breeds method can also be set to coerce the returned JSON results into a pandas DataFrame by setting
the parameter return_df = True.

cat_breeds_df = pf.breeds('cat', return_df = True)
all_breeds_df = pf.breeds(return_df = True)

Finding available animals on Petfinder

The animals() method returns animals based on specified criteria that are listed in the Petfinder database. Specific
animals can be searched using the animal_id parameter, or a search of the database can be performed by entering
the desired search criteria.

# Getting first 20 results without any search criteria
animals = pf.animals()

# Extracting data on specific animals with animal_ids

animal_ids = []
for i in animals['animals'][0:3]:
    animal_ids.append(i['id'])
    
animal_data = pf.animals(animal_id=animal_ids)

# Returning a pandas DataFrame of the first 150 animal results
animals = pf.animals(results_per_page=50, pages=3, return_df=True)

Getting animal welfare organizations in the Petfinder database

Similar to the animals() method described above, the organizations() method returns data on animal welfare
organizations listed in the Petfinder database based on specific criteria, if any. In addition to a general search
of animal welfare organizations, specific organizational data can be extracted by supplying the organizations()
method with organization IDs.

# Return the first 1,000 animal welfare organizations as a pandas DataFrame

organizations = pf.organizations(results_per_page=100, pages=10, return_df=True)

# Get organizations in the state of Washington

wa_organizations = pf.organizations(state='WA')

GitHub

https://github.com/aschleg/petpy