Metadata-Version: 2.1
Name: torrentmirror
Version: 2.0.2
Summary: TorrentMirror API and CLI interface
Author: David Francos
Author-email: opensource@davidfrancos.net
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: cleo (>=0.8.1,<0.9.0)
Requires-Dist: docopt (>=0.6.2,<0.7.0)
Requires-Dist: pygogo (>=0.13.2,<0.14.0)
Requires-Dist: robobrowser (>=0.5.3,<0.6.0)
Requires-Dist: tabulate (>=0.8.7,<0.9.0)
Requires-Dist: xdg (>=5.0.1,<6.0.0)
Requires-Dist: yapf (>=0.30.0,<0.31.0)
Description-Content-Type: text/x-rst

\:tv\: TorrentMirror CLI and python library
=================================================

Python library to expose torrentmirror as a command and python library.

.. contents:: :local:


\:tv\: torrentmirror - TorrentMirror CLI Interface
------------------------------------------------------

You can invoke torrentmirror command to have a nice tabulated list of mirrors
in your terminal

.. image:: http://i.imgur.com/HdY0NIl.png


\:star\: Usage
++++++++++++++++

::

    TorrentMirror.

        Usage: torrentmirror [<torrent_mirror_url>]


\:star\: Installation
---------------------

This is a python package available on pypi.

With python3.8 installed just execute

.. code:: sh

    pip3.8 install torrentmirror


If it asks about permissions and you don't know what to do, you should
probably read `Jamie Matthews's article about virtualenvs <https://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/>`_



\:notebook\: Library Usage
---------------------------

TorrentMirror exposes a simple get_proxies method


.. code:: python

        get_proxies(url="https://www.torrentmirror.net/", renew=False)

It returns a dict in the form

.. code:: python 

        {
          "site_name": [
            {
              "link": "http://foo.com",
              "status": "ONLINE",
              "percentage": 40
            },
            {
              "link": "http://foo.com",
              "status": "ONLINE",
              "percentage": 40
            }
          ]
        }

