Skip to content

Releases: aschleg/petpy

Petpy 1.0.0 Release

14 Nov 14:00
Compare
Choose a tag to compare

Petpy v1.0 Released!

The first major release of the petpy package for interacting with the Petfinder API through Python features convenient and easy-to-use wrapper functions for pulling and extracting data from Petfinder's database. Petpy is most easily installed with pip.

pip install petpy

Documentation can be found here: http://petpy.readthedocs.io

Simple Example

After obtaining an API key and installing petpy, interacting with the Petfinder API is straightforward.

import petpy

pf = petpy.Petfinder(API_KEY) # create an authenticated connection to the Petfinder API
cats = pf.breed_list('cat') # pull all the cat breeds listed in the Petfinder database.

pf.pet_getRandom(output='full') # return a random complete pet record.

Registering for an API key

One must obtain an API key from the Petfinder developer website by creating an account to extract data from the Petfinder database.