Skip to main content

Command line torrent searcher

Project description

[![PyPI version](https://badge.fury.io/py/mariner.svg)](https://badge.fury.io/py/mariner) [![Pipeline status](https://gitlab.com/radek-sprta/mariner/badges/master/pipeline.svg)](https://gitlab.com/radek-sprta/mariner/commits/master) [![Coverage report](https://gitlab.com/radek-sprta/mariner/badges/master/coverage.svg)](https://gitlab.com/radek-sprta/mariner/commits/master)

# Mariner

Mariner is a command line torrent searcher. It offers a simple interface for streamlined experience. No more annoying ads and pop-up windows.

It is currently under heavy development, so expect breaking changes. Currently only works in Linux, but any contributions in this regard are welcome.

## Features

  • Search for torrents on Distrowatch, Linuxtracker, KickAssTorrents, PirateBay and TokyoTosho.

  • Download torrent files and copy magnet links to clipboard.

  • Open torrents in your default torrent application.

  • Show torrent details.

  • Asynchronous I/O for better responsiveness.

![Mariner demonstration](docs/assets/mariner.gif)

## Installation

Mariner requires Python 3.5 or newer to run.

Python package

You can easily install Mariner using pip:

pip3 install mariner

Manual

Alternatively, to get the latest development version, you can clone this repository and then manually install it:

` git clone git@gitlab.com:radek-sprta/mariner.git cd mariner python3 setup.py install `

## Usage

Mariner supports both interactive and non-interactive modes. To see the list of commands, simply type:

mariner help

In order to start Mariner in interactive mode, run it without any arguments:

mariner

Then search for Ubuntu torrents:

(mariner) search Ubuntu -t linuxtracker

and download the first result on the list:

(mariner) download 0

Alternatively, copy the magnet link to clipboard:

(mariner) magnet 0

And quit:

(mariner) quit

For more information, check the [documentation][documentation].

## TODO - Add more trackers for searching - Offer more configuration options - Provide installation methods outside of pip

## Contributing For information on how to contribute to the project, please check the [Contributor’s Guide][contributing]

## Disclaimer I do not want anyone to act in conflict with their local laws and I do not endorse any illegal activity. Some content in the search results provided be Mariner might be illegal in your country and it is up to you to check your local laws before using it. Neither I, nor Mariner can be held liable for any action taken against you as the result of using it.

## Contact [mail@radeksprta.eu](mailto:mail@radeksprta.eu)

[incoming+radek-sprta/mariner@gitlab.com](incoming+radek-sprta/mariner@gitlab.com)

## License GNU General Public License v3.0

[contributing]: https://gitlab.com/radek-sprta/mariner/blob/master/CONTRIBUTING.md [documentation]: https://radek-sprta.gitlab.io/mariner

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

mariner-0.4.0-py3-none-any.whl (26.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page