# Installation instructions

## pip

Note that using pip outside virtualenv is not recommended since it ignores your systems package manager. If you aren’t comfortable debugging package installation issues, this is not the option for you.

Create and activate a virtualenv:

    virtualenv dfwinregenv
    cd dfwinregenv
    source ./bin/activate

Upgrade pip and install dfWinReg dependencies:

    pip install --upgrade pip
    pip install dfwinreg

To deactivate the virtualenv run:

    deactivate

## Ubuntu 22.04 LTS

To install dfWinReg from the GIFT Personal Package Archive (PPA):

    sudo add-apt-repository ppa:gift/stable

Update and install dfWinReg:

    sudo apt-get update
    sudo apt-get install python3-dfwinreg

## Windows

The l2tbinaries contains the necessary packages for running dfWinReg. l2tbinaries provides the following branches:

- main; branch intended for the “packaged release” of dfWinReg and dependencies;

- staging; branch intended for testing pre-releases of dfWinReg;

- dev; branch intended for the “development release” of dfWinReg;

- testing; branch intended for testing newly created packages.

The l2tdevtools project provides an update script to ease the process of keeping the dependencies up to date.

The script requires pywin32.

To install the release versions of the dependencies run:

    set PYTHONPATH=.

    C:\Python3\python.exe tools\update.py --preset dfwinreg