Python wrapper for the Petfinder API. Includes methods for parsing output JSON into pandas DataFrame objects for easier analysis.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
notebooks
petpy
tests
.gitattributes
.gitignore
.travis.yml
CHANGELOG.md
LICENSE.txt
MANIFEST.in
README.md
appveyor.yml
pytest.ini
requirements.txt
setup.cfg
setup.py

README.md

Petpy - Python Wrapper for the Petfinder API

Documentation Status Build Status Build status Coverage Status Codacy Badge https://pypi.org/project/petpy/ https://pypi.org/project/petpy/

🐈 🐕 🐓 🐇 🐎

Petpy is an easy-to-use and convenient Python wrapper for the Petfinder API.

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 git@github.com:aschleg/petpy.git
cd petpy
python setup.py install

Examples and Usage

After receiving an API key from Petfinder, usage of petpy to extract data from the Petfinder database is straightforward.

Authenticating with the Petfinder API

Authenticating the connection with the Petfinder API is as simple as initializing the Petfinder class with an API key received from Petfinder.

pf = Petfinder(key)

Getting currently listed animal breeds on Petfinder

Once the Petfinder class has been initialized with a key received from Petfinder, the methods can then be used to interact with and extract data from the Petfinder API. In this example, we use the pf object created above to get the currently listed breeds of cats and dogs.

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

# The 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.breed_list('cat', return_df = True)
dog_breeds_df = pf.breed_list('dog', return_df = True)

Finding available pets in specific locations

The pet_find method returns animals available on Petfinder at local animal shelters given a specific location. The location can be as granular as a city or as broad as a country in North America. For example, let's say we are interested in finding the first 100 female cats available for adoption in the Seattle area and coerce the default JSON results into a pandas DataFrame for easier analysis.

wa_female_cats = pf.pet_find(location='Seattle', 
                             animal='cat', 
                             sex='Female', 
                             count=100, 
                             return_df=True) 

Locating animal shelters in a given location

The shelter_find method is similar to the pet_find method above, with the exception that it returns the location and information on shelters within the given region specified in the location parameter. The Petfinder API will automatically extend its search for shelters if the count exceeds the number of shelters in the specified area. For example, let's say we wanted to find 500 animal shelters in Seattle, Washington. As there are not 500 shelters in Seattle alone, the API will expand its return results to include likely most, if not, all of Washington State and likely surrounding states like Oregon and Idaho until it finds 500 shelters to return. As with the pet_find method, the shelter_find method also has a return_df parameter that automatically transforms the returned JSON data from the API into a pandas DataFrame.

wa_shelters = pf.shelter_find(location='Seattle',
                              count=500,
                              return_df=True)

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.

Introduction and Example Uses of petpy

Binder

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.

Documentation

Requirements

  • Python 2.7 or Python >= 3.4
  • requests >= 2.18.4
  • Although not strictly required for installation or use, the pandas library is needed for returning the results as a DataFrame.

License

MIT