mirror of https://github.com/vikstrous/pirate-get synced 2025-01-09 09:59:51 +01:00

A command line interface for The Pirate Bay

Go to file

Jacob Bortell 838a5973b9 Add -r/--total-results to limit search results -r/--total-results allows the user to specify the number of links to return in the search. Because this option operates on the total search results, i.e. it's not the number of links to show per page, -p/--pages is ignored if --total-results is set. Perhaps in the future this option can be extended to operate by page. Added total-results to config total-results is set in the config to be 50 by default. I also reverted the logic that only one page would be fetched if total-results is set. Now it has the original behavior: any number of pages can be requested, and total-results will filter the final result. Minor wording update Wording change also for cli parameter		2021-12-26 12:11:06 +01:00
pirate	Add -r/--total-results to limit search results	2021-12-26 12:11:06 +01:00
tests	reimplement fetching multiple pages	2020-05-25 10:55:26 +02:00
.coveragerc	configure cover better	2015-09-17 00:02:32 -07:00
.gitignore	ignore .pypirc	2018-06-16 10:28:26 -07:00
circle.yml	configure cicleci again	2020-03-31 07:51:09 -04:00
LICENSE	move license, better shields	2015-09-11 23:23:08 -07:00
README.md	Add -r/--total-results to limit search results	2021-12-26 12:11:06 +01:00
renovate.json	enable renovate	2018-11-05 20:16:42 -08:00
requirements-test.txt	add coveralls	2015-09-11 22:42:51 -07:00
requirements.txt	move requirements to setup.py only	2015-08-30 10:51:34 -07:00
setup.py	fix missing data in release tarball	2020-05-28 13:48:19 +02:00

README.md

pirate-get

pirate-get is a convenient command line tool (inspired by APT) to speed up your trip to the Pirate Bay and get your completely legal torrents more quickly.

Installation

Make sure you have python 3.4 and pip installed. On Ubuntu 14.04 you may also need to install the libxslt1-dev and libxml2-dev packages.

Run pip3 install pirate-get

Usage

To search use pirate-get [search term].

See pirate-get -h for more options.

Watch this for an example usage.

Configuration file

You can use a file to override pirate-get's default settings. Default is $XDG_CONFIG_HOME/pirate-get. If it does not exist then $HOME/.config/pirate-get.

Default config file

Here the available options and their behaviors are when unset:

[Save]
; directory where to save files
directory = $PWD

; save each selected magnet link in a .magnet file
magnets = false

; save each selected torrent in a .torrent file
torrents = false

[LocalDB]
; use a local copy of the csv formatted pirate bay database
enabled = false

; path of the database
path = ~/downloads/pirate-get/db

[Search]
; maximum number of results to show
total-results = 50

[Misc]
; specify a custom command for opening the magnet
; ex. myprogram --open %s
; %s represent the magnet uri
openCommand =

; open magnets with transmission-remote client
transmission = false
; set to username:password if needed
transmission-auth =
; set to the port number if needed
transmission-port =

; use colored output
colors = true

; the pirate bay mirror(s) to use:
; one or more space separated URLs
mirror = http://thepiratebay.org

Note: Any command line option will override its respective setting in the config file.

Local Database

If you want to use a local copy of the Pirate Bay database download a copy here (or wherever the latest version is currently):

https://thepiratebay.org/static/dump/csv/

License

pirate-get is licensed under the GNU Affero General Public License version 3 or later. See the accompanying file LICENSE or http://www.gnu.org/licenses/agpl.html.