https://github.com/karan/tpb
:cloud: Python API for ThePirateBay.
https://github.com/karan/tpb
Last synced: 28 days ago
JSON representation
:cloud: Python API for ThePirateBay.
- Host: GitHub
- URL: https://github.com/karan/tpb
- Owner: karan
- License: mit
- Created: 2013-09-01T15:54:54.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-03-27T18:12:06.000Z (almost 6 years ago)
- Last Synced: 2025-02-12T07:10:57.170Z (11 months ago)
- Language: HTML
- Homepage:
- Size: 1020 KB
- Stars: 331
- Watchers: 28
- Forks: 65
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Unofficial Python API for [ThePirateBay](http://thepiratebay.org/).
| Build Status | Test Coverage | Version | Downloads (30 days) |
| ------------ | ------------- | ------- | ------------------- |
| [](https://travis-ci.org/karan/TPB) | [](https://coveralls.io/r/karan/TPB) | [](https://pypi.python.org/pypi/ThePirateBay/) | [](https://pypi.python.org/pypi/ThePirateBay/) |
Installation
=============
```sh
$ pip install ThePirateBay
```
Note that ``ThePirateBay`` depends on ``lxml``. If you run into problems in the compilation of ``lxml`` through ``pip``, install the ``libxml2-dev`` and ``libxslt-dev`` packages on your system.
Usage
==========
```python
from tpb import TPB
from tpb import CATEGORIES, ORDERS
t = TPB('https://thepiratebay.org') # create a TPB object with default domain
# search for 'public domain' in 'movies' category
search = t.search('public domain', category=CATEGORIES.VIDEO.MOVIES)
# return listings from page 2 of this search
search.page(2)
# sort this search by count of seeders, and return a multipage result
search.order(ORDERS.SEEDERS.ASC).multipage()
# search, order by seeders and return page 3 results
t.search('python').order(ORDERS.SEEDERS.ASC).page(3)
# multipage beginning on page 4
t.search('recipe book').page(4).multipage()
# search, in a category and return multipage results
t.search('something').category(CATEGORIES.OTHER.OTHER).multipage()
# get page 3 of recent torrents
t.recent().page(3)
# get top torrents in Movies category
t.top().category(CATEGORIES.VIDEO.MOVIES)
# print all torrent descriptions
for torrent in t.search('public domain'):
print(torrent.info)
# print all torrent files and their sizes
for torrent in t.search('public domain'):
print(torrent.files)
```
Torrent details available
==================
Attributes
----------
* **title** # the title of the torrent
* **url** # TPB url for the torrent
* **category** # the main category
* **sub_category** # the sub category
* **magnet_link** # magnet download link
* **torrent_link** # .torrent download link
* **created** # uploaded date time
* **size** # size of torrent
* **user** # username of uploader
* **seeders** # number of seeders
* **leechers** # number of leechers
Properties
----------
* **created** # creation date -- parsed when accessed
* **info** # detailed torrent description -- *needs separate request*
* **files** # dictionary of files and their size -- *needs separate request*
Tests
=====
Tests can be ran using `tox`.
```sh
$ pip install tox
$ tox
```
Alternatively, you will need to install dependencies manually:
```sh
$ pip install -r tests/requirements.txt
```
Then, to execute the tests simply run:
```sh
$ python -m unittest discover
```
By default the tests are ran on a local test server with predownloaded original
responses. You can activate the remote running option by:
```sh
$ REMOTE=true python -m unittest discover
```
Donations
========
If *TPB* has helped you in any way, and you'd like to help the developer, please consider donating.
**- BTC: [19dLDL4ax7xRmMiGDAbkizh6WA6Yei2zP5](http://i.imgur.com/bAQgKLN.png)**
**- Gratipay: [https://www.gratipay.com/karan/](https://www.gittip.com/karan/)**
**- Flattr: [https://flattr.com/profile/thekarangoel](https://flattr.com/profile/thekarangoel)**
Contribute
========
If you want to add any new features, or improve existing ones, feel free to send a pull request!