Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.7 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.7 KB

helpjuice

A Python wrapper of the Helpjuice API

Version Python License: GPL v3 Tests Codecov Docs

This package allows Python developers to write software that makes use of the Helpjuice API. Functions available in the API are mirrored in this package as closely as possible, translating JSON responses to Python objects. You can find the current documentation for the Helpjuice API here:

Helpjuice API Documentation

Installing

pip install helpjuice

Quick Start

from helpjuice import Client

helpjuice = Client(account="your-account", api_key="ffb722a62e8**********************")

# Get a single article
article = helpjuice.Article(id=1).get()

# Search for articles with pagination
for question in helpjuice.Search().get(query="foo", limit=1000, paginate=True):
    print(question)