1. Installation

Windows

These installation instructions were tested on Ubuntu running under WSL2. They should work the same under a standalone Ubuntu install.

1. Install WSL2. Follow the instructions at Windows Subsystem for Linux Installation Guide for Windows 10.

2. After installing Ubuntu, launch it, setup a username and password then execute:
   sudo apt update

3. Follow the Linux instructions (Debian/Ubuntu)

Linux

Install the system-level prerequisites

sudo apt install python3 mediainfo ffmpeg mktorrent (Debian/Ubuntu)

Choose one of the following ways to install pythonbits

1. pipx
   👍 Recommended for end-users 👶

   1. Install pipx:
      sudo apt install pipx (Debian/Ubuntu)
   2. Install pythonbits:
      pipx install pythonbits (current release)
      pipx install git+https://github.com/mueslo/pythonbits.git@master (e.g. latest master dev version, at your own risk)

2. Basic virtualenv
   🛠️ Recommended for development purposes 🧙‍♂️

   1. Install virtual environments, which will keep different python projects separated and prevent dependency conflicts:
      sudo apt install python3-venv (Debian/Ubuntu)

   2. Create a virtual environment for pythonbits:
      python3 -m venv pythonbits

   3. Activate the virtual environment:
      source pythonbits/bin/activate

   4. Install pythonBits:
      python3 -m pip install pythonbits

   Remember that you need to activate the virtualenv again the next time you open a console and wish to run pythonbits.

3. No virtualenv
   ⚠️ NOT RECOMMENDED ☠️
   Other things you install may conflict with pythonbits's requirements. Only use this if this is the only python package you will be installing.
   pip install --user pythonbits

Ensure it's installed

pythonbits --version

Check out usage examples

Upgrading

If installed using pip, enter your virtual environment and run pip install --upgrade pythonbits. For pipx, run pipx upgrade pythonbits.