diff --git a/.gitignore b/.gitignore index cbd75e2..352335d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ \.idea/ setup\.py + +setup\.cfg diff --git a/README.md b/README.md index 8bc4e09..e47bbea 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ -Python-Trivia-API +# Python Trivia API +## Install +``` +pip install pytrivia +``` + +## Requirements +``` +requests +``` + +## Example usage +```Python +from pytrivia import Category, Diffculty, Type, Trivia +my_api = Trivia(True) +response = my_api.request(2, Category.Books, Diffculty.Hard, Type.True_False) +print(reqponse) +``` + +## Full method signature +```Python +def request(self, num_questions: int, category: Category = None, + diffculty: Diffculty = None, type_: Type = None): + """ + Send an api request to https://opentdb.com/ + Limitations: + Only 1 Category can be requested per API Call. + To get questions from any category, don't specify a category. + A Maximum of 50 Questions can be retrieved per call. + + :param num_questions: the number of questions, + must be between 1 and 50 (inclusive) + + :param category: the category of the question. None for any category + + :param diffculty: the diffculty of the question. None for any diffculty + + :param type_: the type of the question. None for any type + + :return: the api call response + + :rtype: dict + + :raises: ValueError when the num_questions parameter is less than 1 + or greater than 50 + """ +``` \ No newline at end of file diff --git a/pytrivia/__init__.py b/pytrivia/__init__.py index c28cd91..a2f8085 100644 --- a/pytrivia/__init__.py +++ b/pytrivia/__init__.py @@ -51,14 +51,14 @@ class Trivia: def __init__(self, with_token: bool): """ Initialize an instance of the Trivia class - :param with_token: whether if the instance uses a session token + :param with_token: If True then the instance will uses a session token """ self.token = _get_token() if with_token else None def request(self, num_questions: int, category: Category = None, diffculty: Diffculty = None, type_: Type = None): """ - Send a api + Send an api request to https://opentdb.com/ Limitations: Only 1 Category can be requested per API Call. To get questions from any category, don't specify a category. @@ -76,6 +76,9 @@ def request(self, num_questions: int, category: Category = None, :return: the api call response :rtype: dict + + :raises: ValueError when the num_questions parameter is less than 1 + or greater than 50 """ if num_questions < 1 or num_questions > 50: raise ValueError