diff options
| -rw-r--r-- | README.md | 16 | ||||
| -rw-r--r-- | setup.py | 2 |
2 files changed, 16 insertions, 2 deletions
@@ -1,5 +1,7 @@ Unofficial Lightweight Python API for ThePirateBay +[](https://badge.fury.io/py/tpblite) + Installation ============= ```sh @@ -55,6 +57,18 @@ torrents = t.browse(category=CATEGORIES.VIDEOS) torrents = t.browse(category=CATEGORIES.VIDEO.MOVIES, page=1, order=ORDERS.UPLOADED.DES) ``` +## Top +```python +from tpblite import TPB, CATEGORIES +t = TPB() + +# Get the top recent torrents +torrents = t.top(CATEGORIES.GAMES.ALL) + +# Customize with category and restriction to torrents from the last 48h +torrents = t.top(category=CATEGORIES.GAMES.ALL, last_48=True) +``` + ## Categories and Sort Order ```python # To print all available categories, use the classmethod printOptions @@ -74,6 +88,7 @@ You can see how many `Torrent` objects your query has returned, by using the `le ## Torrent object `Torrent` objects represent each torrent found in the `Torrents` class, they have the following attributes + ### Attributes - `Torrent.title` - The name of the torrent (str) - `Torrent.seeds` - The number of seeders (int) @@ -85,7 +100,6 @@ You can see how many `Torrent` objects your query has returned, by using the `le - `Torrent.magnetlink` - magnetlink of the torrent (str) - `Torrent.url` - url of the torrent page (str) - Example Workflow ========== @@ -7,7 +7,7 @@ this_dir = path.abspath(path.dirname(__file__)) with open(path.join(this_dir, 'README.md'), encoding='utf-8') as f: long_description = f.read() -version = '0.3.0' +version = '0.4.0' setup(name = 'tpblite', version = version, |