Skip to content

Latest commit

 

History

History
82 lines (70 loc) · 2.95 KB

uv.md

File metadata and controls

82 lines (70 loc) · 2.95 KB
title description published date tags editor dateCreated
Install FlexGet with uv
Installing FlexGet using uv
true
2025-01-14 17:28:47 UTC
markdown
2025-01-10 03:22:17 UTC

Installing FlexGet with uv

uv has multiple purposes, but one of them (uv tool) is to easily install python based CLI tools (like FlexGet!) and not worry about the virtual environment or python management yourself. Here are the steps to install and update FlexGet using uv tool.

Install uv

Instructions can be found at the uv website.

Install FlexGet

We can then use uv to install FlexGet.

uv tool install flexget[locked]

This will install FlexGet into a uv managed virtual environment, and add the binaries to your PATH. The locked extra is not required, but is recommended, and makes sure you get the exact dependencies that we have tested with.

Specifying python version

You can also specify what version of python you would like to use

uv tool install flexget[locked] --python 3.12

One of our deps (pendulum) does not provide wheels for python 3.13 at the moment. You probably want to manually specify python 3.12 for now to avoid complications. {.is-warning}

Adding extra dependencies

There are several extras we include that install optional dependencies needed by some of the most common plugins. They are:

  • deluge
  • qbittorrent
  • transmission
  • telegram
  • all (this will include all 4 of the above)

You can specify them when installing and an appropriate version of the dependency will be installed and upgraded alongside flexget for you. e.g.

uv tool install flexget[locked,all]
uv tool install flexget[locked,deluge,telegram]

If you need extra dependencies other than the extras listed above, they can also be specified.

uv tool install flexget[locked] --with myotherdependency

If you later decide you want to switch python versions or change extras, you can simply run the uv tool install command again with your new options. {.is-info}

Run FlexGet

FlexGet will be added to your PATH, so you can run it from anywhere.

flexget --help

Updating

To update to the latest version of FlexGet, you can run:

uv tool upgrade flexget

If you need to get a specific version, you can specify it:

uv tool upgrade flexget==3.13.10

You probably don't want to specify a specific FlexGet version during uv tool install, as this version constraint will keep applying when you try to uv tool upgrade later. It is better to do the install, then "upgrade" to the specific version you need right now. {.is-warning}

Uninstalling

If you installed with this method, you can:

uv tool uninstall flexget

Next Step

Choose your OS to continue setting up scheduling: