Installation

Here you will find instructions on Installing the program for various operating systems.

Installing Python

Before using the program, you just install Python on your computer. The minimum required version is Python 3.10.

If you are not sure which version of Python you' have installed, use the python -V command (or the pip -V command).

Windows

Download the Windows installer from python.org/downloads/windows/ and execute it.

macOS

Download the macOS 64-bit universal2 installer from python.org/downloads/macos/ and execute it.

Alternatively, you can use Homebrew and install the [email protected] formula with brew install [email protected].

Linux

Use your distribution's package manager to install the python package. The name may vary depending on the distribution:

• Red Hat, CentOS or Fedora: install the python3 package
• Debian or Ubuntu: install the python3.10 package
• Arch: install the python package
• Gentoo: install the =python-3.x* ebuild (you may have to unmask it first)

Installing pip

Most distributions of Python come with pip installed, however some Linux distributions do not bundle pip with the python package.

To test if pip is installed, open a terminal and use the pip -V command. If it prints a "command not found" error, then you need to install pip manually.

The suggested way is to use the python -m ensurepip --upgrade command, but you can also install it manually using your distribution's package manager.

• Debian or Ubuntu: install the python3-pip package
• Arch: install the python-pip package

Installing FALocalRepo

With Python 3.10+ ready, FALocalRepo can now be installed using pip.

Open a terminal and run the following command:

pip install falocalrepo

That's it, FALocalRepo is now ready to start!