From 87155dd4b37234628aebc41fcce123da439b5566 Mon Sep 17 00:00:00 2001 From: Matt Lyon Date: Wed, 25 Dec 2019 17:57:37 +0000 Subject: updated README, added some comments --- tpblite/tpblite.py | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) (limited to 'tpblite') diff --git a/tpblite/tpblite.py b/tpblite/tpblite.py index 3c68d62..1ec3991 100644 --- a/tpblite/tpblite.py +++ b/tpblite/tpblite.py @@ -29,12 +29,14 @@ class TPB: Args: query: Search string to query ThePirateBay - page: page number to grab results from - order TODO - category TODO + page: Page number to grab results from + order: Order of results, default is ascending. List of possible options found in + tpblite.models.constants.ORDERS + category: Restrict search to specific category, for list of categories see + tpblite.models.constants.CATEGORIES Return: - Torrents + Torrents object """ q = QueryParser.search(query, self.base_url, page, order, category) @@ -46,12 +48,14 @@ class TPB: Args: query: Search string to query ThePirateBay - page: page number to grab results from - order TODO - category TODO + page: Page number to grab results from + order: Order of results, default is ascending. List of possible options found in + tpblite.models.constants.ORDERS + category: Restrict search to specific category, for list of categories see + tpblite.models.constants.CATEGORIES Return: - Torrent + Torrents object """ q = QueryParser.browse(self.base_url, category, page, order) -- cgit v1.2.3