SmokeAPI: A Python wrapper for the MetaSmoke API¶
Release v0.2.0. (Installation)
SmokeAPI is a simple Python wrapper for the MetaSmoke API .
Retrieving data from the API is simple:
from smokeapi import SmokeAPI
SMOKE = SmokeAPI('your_api_key')
posts = SMOKE.fetch('posts/feedback', type="naa-")
The above, will issue a call to the
Posts Feedback
. end point on MetaSmoke.
Supported Features¶
- Read and write functionality via the API.
- Retrieve multiple pages of results with a single call and merge all the results into a single response.
- Throw exceptions returned by the API for easier troubleshooting.
- Utilize Requests.
SmokeAPI is supported on Python 2.7 - 3.5.
User Guide¶
This portion of documentation provides details on how to utilize the library, and provides advanced examples of various use cases.
The API Documentation¶
Information about specific functions, classes, and methods are available in this portion of documentation.
Contributor Guidelines¶
Information about how to contribute to the project is available in this portion of the documentation.