GitHubInstall.md

title	description	published	date	tags	editor	dateCreated
GitHubInstall		true	2025-01-10 02:43:42 UTC		markdown	2022-09-18 04:49:49 UTC

Install Wizard > GitHub Install

Notes

• Requires Python 3.9+, uv, and git client
• This where we develop

Install uv

uv is a Python package and project manager. Install instructions can be found here.

Initial clone

To checkout use this command:

$ git clone https://github.com/Flexget/Flexget.git ~/flexget-dev

You can use whatever directory you like in place of ~/flexget-dev.

uv sync

In your virtualenv, run uv sync. This will create a virtualenv in the .venv directory within your checkout, and install flexget in editable mode, (such that editing your checkout will directly edit the copy of flexget that runs in your venv,) and all of the needed dependencies.

Running FlexGet in the venv

To run Flexget (or any other command) inside the venv, you can use uv run followed by the command. e.g.

$ uv run flexget execute

or, you can explicitly run the binaries from the venv

$ ~/flexget-dev/.venv/bin/flexget execute

Upgrading

To upgrade your install, first pull the changes from our repo:

$ cd ~/flexget-dev
$ git pull

If the dependencies have changed, you can re-sync to upgrade all the dependencies:

$ uv sync

Become a contributor

If you're interested in helping to improve FlexGet, or adding new plugins, please read our contribute page.