Metadata-Version: 2.4
Name: fixitpy
Version: 0.2.14
Summary: iFixit REST API Interface
License-Expression: MIT
Project-URL: Homepage, https://github.com/voldgalf/fixitpy
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: license-file

# fixitPy

Python iFixit API interface.

Currently you can retrieve guides and their prerequisite guides
## Installation

To install fixitPy

````bash
pip install fixitpy
````

### Using the library

#### Retrieving a guide *without prerequisites*

This returns a dict that contains information pertaining to the guide

````py
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`

````py
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"))
````

# License

MIT License
