jservicepy 1.0

Description:

jservicepy 1.0

jServicePy
API wrapper for jService (comes with a commmand-line game implementation!)

A wrapper for jService and a small command-line based version of Jeopardy using said wrapper with ANSI escape codes.
Examples
API
from jservicepy import jService
jeopardy = jService() # <- If you're running your own instance, put your base URL in here
clues = jeopardy.clues()
for clue in clues:
print(clue.question + ':', clue.answer, '| $' + str(clue.value))

CLI
python -m jservicepy -h
usage: jServicePy [-h] [-c NUMBER] [-r NUMBER] [-v]

Play Jeopardy in your terminal! Powered by @sottenad's jService
[https://github.com/sottenad/jService] (v1.0)

optional arguments:
-h, --help show this help message and exit
-c NUMBER, --categories NUMBER
Answer questions from a NUMBER of random categories.
-r NUMBER, --random NUMBER
Answer a NUMBER of random questions
-v, --version show program's version number and exit

Application Programming Interfacte Documentation
class jService
init
Initialize jService.
Args:

baseURL (str, optional): Base URL to send requests to; use if you are making calls to your own instance of jService. Defaults to "https://jservice.io".

categories
Get a list of categories.
Args:

count (int, optional): Amount of categories to return, limited to 100 at a time. Defaults to 1.
offset (int, optional): Offsets the starting ID of categories returned. Useful in pagination. Defaults to 0.

Returns:

list: A list of Category dataclasses.

category
Get a category.
Args:

id (int): The ID of the category to return.

Returns:

Category: A dataclass containing the cateory ID, title, number of clues, and list of clues for the category.

clues
Get a list of clues.
Args:

value (int, optional): The value of the clue in dollars.
category (int, optional): The id of the category you want to return.
min_date (datetime, optional): Earliest date to show, based on original air date.
max_date (datetime, optional): Latest date to show, based on original air date.
offset (int, optional): Offsets the returned clues. Useful in pagination.

Returns:

list: A list of Clue dataclasses.

random
Get random clues.
Args:

count (int, optional): Amount of clues to return, limited to 100 at a time. Defaults to 1.

Returns:

list: A list of Clue dataclasses.