fixitpy 0.2.15

iFixit REST API Interface

fixitPy

Python iFixit API interface.

Currently, you can retrieve guides and their prerequisite guides

Installation

To install fixitPy

pip install fixitpy

Using the library

Retrieving a guide without prerequisites

This returns a dict that contains information pertaining to the guide

import fixitpy

found_guide = fixitpy.retrieve_guide(123) # call the retrieve_guide function which returns a dict

print(found_guide.get("title"))
print(found_guide.get("difficulty"))

Retrieving a guide with prerequisites

A prerequisite is an optional guide that the retrieved guide recommends you start with before. The prerequisite guide is the same dict structure of what returns from fixitpy.retrieve_guide

import fixitpy

found_guide = fixitpy.retrieve_guide(123, get_prerequisites=True) # call the retrieve_guide function which returns a dict

print(found_guide.get("title"))
print(found_guide.get("difficulty"))

first_prerequisite = found_guide.get("prerequisites")[0]
print(first_prerequisite.get("title"))

Getting Guide Steps

What makes a repair guide, a guide is the inclusion of steps to follow.

import fixitpy

found_guide = fixitpy.retrieve_guide(123, get_prerequisites=True) # call the retrieve_guide function which returns a dict

print(found_guide.get("title"))
print(found_guide.get("difficulty"))

for step in found_guide.get("steps"):
    print(step.get("title")) # this is the title of each step
    print(step.get("steps")) # this is a list of each sentence of the current step

License

MIT License