mirror of
https://github.com/vikstrous/pirate-get
synced 2025-01-09 09:59:51 +01:00
838a5973b9
-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
83 lines
3.1 KiB
Markdown
83 lines
3.1 KiB
Markdown
# pirate-get
|
|
[](https://circleci.com/gh/vikstrous/pirate-get/tree/master) [](https://coveralls.io/github/vikstrous/pirate-get?branch=master) [](https://codeclimate.com/github/vikstrous/pirate-get) [](https://www.codacy.com/app/me_29/pirate-get) [](https://gemnasium.com/vikstrous/pirate-get) [](https://raw.githubusercontent.com/vikstrous/pirate-get/master/LICENSE) [](https://pypi.python.org/pypi/pirate-get/) [](https://pypi.python.org/pypi/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](http://showterm.io/d6f7a0c2a5de1da9ea317) 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:
|
|
|
|
```INI
|
|
[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.
|