Metadata-Version: 2.0
Name: FlexGet
Version: 2.2.1
Summary: FlexGet is a program aimed to automate downloading or processing content (torrents, podcasts, etc.) from different sources like RSS-feeds, html-pages, various sites and more.
Home-page: http://flexget.com
Author: Marko Koivusalo
Author-email: marko.koivusalo@gmail.com
License: MIT
Download-URL: http://download.flexget.com
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: FeedParser (>=5.2.1)
Requires-Dist: PyRSS2Gen
Requires-Dist: PyYAML
Requires-Dist: SQLAlchemy (>=1.0.9,<1.999)
Requires-Dist: Safe (>=0.4)
Requires-Dist: apscheduler (>=3.2.0)
Requires-Dist: beautifulsoup4 (>=4.1,!=4.2.0,<4.5)
Requires-Dist: cherrypy (>=3.7.0)
Requires-Dist: flask (>=0.7)
Requires-Dist: flask-compress (>=1.2.1)
Requires-Dist: flask-cors (>=2.1.2)
Requires-Dist: flask-login (>=0.3.2)
Requires-Dist: flask-restful (>=0.3.3)
Requires-Dist: flask-restplus (==0.8.6)
Requires-Dist: future (>=0.15.2)
Requires-Dist: guessit (<=2.0.4)
Requires-Dist: html5lib (>=0.11,<=0.9999999)
Requires-Dist: jinja2
Requires-Dist: jsonschema (>=2.0)
Requires-Dist: path.py (>=8.1.1)
Requires-Dist: pathlib (>=1.0)
Requires-Dist: pynzb
Requires-Dist: pyparsing (>=2.0.3)
Requires-Dist: python-dateutil (>=2.5.2)
Requires-Dist: requests (>=2.8.0,<3.0)
Requires-Dist: rpyc
Provides-Extra: dev
Requires-Dist: boto3; extra == 'dev'
Requires-Dist: click; extra == 'dev'
Requires-Dist: codacy-coverage (>=1.2.18); extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: gitpython; extra == 'dev'
Requires-Dist: mock; extra == 'dev'
Requires-Dist: pylint; extra == 'dev'
Requires-Dist: pytest (>=2.7); extra == 'dev'
Requires-Dist: pytest-capturelog; extra == 'dev'
Requires-Dist: pytest-cov (==2.2.1); extra == 'dev'
Requires-Dist: pytest-runner; extra == 'dev'
Requires-Dist: pytest-xdist; extra == 'dev'
Requires-Dist: requests; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: vcrpy (>=1.7.4); extra == 'dev'
Requires-Dist: virtualenv; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'

FlexGet
=======

`FlexGet`_ is a multipurpose automation tool for content like torrents, nzbs,
podcasts, comics, series, movies, etc. It can use different kinds of sources
like RSS-feeds, html pages, csv files, search engines and there are even
plugins for sites that do not provide any kind of useful feeds.

There are numerous plugins that allow utilizing FlexGet in interesting ways
and more are being added continuously.

FlexGet is extremely useful in conjunction with applications which have watch
directory support or provide interface for external utilities like FlexGet.

.. _FlexGet: http://flexget.com

.. image:: https://api.travis-ci.org/Flexget/Flexget.png?branch=master
    :target: https://travis-ci.org/Flexget/Flexget

.. image:: https://img.shields.io/pypi/v/Flexget.svg
    :target: https://pypi.python.org/pypi/Flexget

.. image:: https://img.shields.io/pypi/dm/Flexget.svg
    :target: https://pypi.python.org/pypi/Flexget

.. image:: https://api.codacy.com/project/badge/Grade/81e8ae42c7544dc48853102b1b7f88d5
    :target: https://www.codacy.com/app/Flexget/Flexget?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Flexget/Flexget&amp;utm_campaign=Badge_Grade

.. image:: https://api.codacy.com/project/badge/Coverage/81e8ae42c7544dc48853102b1b7f88d5
    :target: https://www.codacy.com/app/Flexget/Flexget?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Flexget/Flexget&amp;utm_campaign=Badge_Coverage

.. image:: https://badges.gitter.im/Flexget/Flexget.svg
    :alt: Join the chat at https://gitter.im/Flexget/Flexget
    :target: https://gitter.im/Flexget/Flexget?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. image:: http://isitmaintained.com/badge/resolution/Flexget/Flexget.svg
    :target: http://isitmaintained.com/project/Flexget/Flexget


**Help:** http://discuss.flexget.com/

**Chat:** http://webchat.freenode.net/?channels=#flexget or https://gitter.im/Flexget/Flexget

**Bugs:** https://github.com/Flexget/Flexget/issues

Install
-------

FlexGet is installable via pip with the command::

    pip install flexget

For more detailed instructions see the `installation guide`_.

.. _installation guide: http://flexget.com/Install

How to use GIT checkout
-----------------------

Check that you have Python 2.7 / 3.3 or newer available with command ``python -V``.

In some environments newer python might be available under another name like 
'python2.7' or 'python3' in which case you need to use that one instead of 
plain 'python'.

To start using FlexGet from this directory:

First, install (a recent version of) the `virtualenv`_ package to your system.

.. _virtualenv: https://pypi.python.org/pypi/virtualenv

Now, in your checkout directory, run::

    virtualenv .

Or, if you need deluge or transmission libraries from system wide python use::

    virtualenv --system-site-packages .

This will initialize python virtualenv. This doesn't need to be directly in
your checkout directory, but these instructions assume that's where it is.

Next we need to install dependencies and FlexGet itself, this can be done simply::

    bin/python setup.py develop

After that FlexGet is usable via ``<checkout directory>/bin/flexget``. Verify
installation by running::

    bin/flexget -V

You may place the config file in your checkout directory, or in ``~/.flexget``
(Unix, Mac OS X) or ``C:\Documents and Setting\<username>\flexget`` (Windows).

If you don't want to use virtualenv there's ``flexget_vanilla.py`` file which
can be used to run FlexGet without virtualenv, note that you will need to
install all required dependencies yourself.

Install using Docker (Linux only)
---------------------------------

Docker can be used to install and run FlexGet::

    docker run -it -v /home/<username>/.flexget:/root/.flexget --rm toilal/flexget


