/Flexget

The official FlexGet repository

Primary LanguagePythonMIT LicenseMIT

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.

image

image

image

image

Join the chat at https://gitter.im/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.

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

How to use GIT checkout

Check that you have Python 2.7 available with command python -V.

In some environments newer (or older, if your distro is on python 3,) python might be available under another name like 'python2.7' 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.

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. Now use pip from your new virtualenv to install paver, then install flexget from your checkout dir in editable mode:

bin/pip install paver
bin/pip install -e .

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 bootstrapping, note that you will need to install all required dependencies yourself.