Skip to main content

iFixit REST API Interface

Project description

fixitPy

Interface with the iFixit API through Python, easily.

Current Features

  • Guide Retrieval

WIP Features

  • Guide image retrieval
  • text based searching for guides

Installation

To install fixitPy

pip install fixitpy

Import the library

import fixitpy

Using the library

Getting a guide

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

print(found_guide.get("title")) # get various dict members
print(found_guide.get("difficulty"))

Getting a guide with prerequisites

Many iFixit guides provide prerequisite guides, this is optional to retrieve

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

print(found_guide.get("title")) # get various dict members
print(found_guide.get("difficulty"))

Full example

import fixitpy

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

print(found_guide.get("title")) # get various dict members
print(found_guide.get("difficulty"))

License

MIT License

Project details


Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page