Metadata-Version: 2.0
Name: mariner
Version: 1.0.2
Summary: Command line torrent searcher
Home-page: http://gitlab.com/radek-sprta/mariner
Author: Radek Sprta
Author-email: mail@radeksprta.eu
License: GNU GPLv3
Download-URL: https://gitlab.com/radek-sprta/mariner/repository/archive.tar.gz?ref=master
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.5
Requires-Dist: aiodns
Requires-Dist: aiofiles
Requires-Dist: aiohttp
Requires-Dist: bs4
Requires-Dist: cachalot (>=0.1.2)
Requires-Dist: cliff
Requires-Dist: colorama
Requires-Dist: future-fstrings
Requires-Dist: lxml
Requires-Dist: maya (>=0.3.4)
Requires-Dist: ruamel.yaml

Mariner |PyPI version| |Pipeline status| |Coverage report|
==========================================================

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.

.. figure:: docs/assets/mariner.gif
   :alt: Mariner demonstration

   Mariner demonstration

Installation
------------

Mariner requires Python 3.5 or newer to run.

**Python package**

You can easily install Mariner using pip. This is the preferred method:

``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

**Docker**

There is now also a Docker image available for Mariner, although I
haven't tested it extensively. You can run it with the following
command:

``docker run [options] registry.gitlab.com/radek-sprta/mariner [arguments]``

**Snap**

You can also try the Mariner snap from snap store. Its in its, however,
so do not be surprised by bugs. Install the snap by running:

``snap install mariner --edge``

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``

Or open it in your torrent application:

``(mariner) open 0``

And quit the program:

``(mariner) quit``

For more information, check the
`documentation <https://radek-sprta.gitlab.io/mariner>`__.

TODO
----

-  Add more trackers for searching
-  Offer more configuration options

Contributing
------------

For information on how to contribute to the project, please check the
`Contributor's
Guide <https://gitlab.com/radek-sprta/mariner/blob/master/CONTRIBUTING.md>`__

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

`incoming+radek-sprta/mariner@gitlab.com <incoming+radek-sprta/mariner@gitlab.com>`__

License
-------

GNU General Public License v3.0

.. |PyPI version| image:: https://badge.fury.io/py/mariner.svg
   :target: https://badge.fury.io/py/mariner
.. |Pipeline status| image:: https://gitlab.com/radek-sprta/mariner/badges/master/pipeline.svg
   :target: https://gitlab.com/radek-sprta/mariner/commits/master
.. |Coverage report| image:: https://gitlab.com/radek-sprta/mariner/badges/master/coverage.svg
   :target: https://gitlab.com/radek-sprta/mariner/commits/master


