Also see the following pages for platform-specific installation information
The recommended way of installing portmod is to install it through your system package manager, if possible. If you can use this method, you should not need to do anything else and can continue to the Setup Guide.
If your system package manager doesn’t include portmod, you can also
install via pip. Note that the
--upgrade flag can be used if you have
previously installed portmod to ensure that you have the latest version.
You must use a version of python which is supported by portmod (See Manual Installation).
pip3 install portmod --upgrade
Note that this will only install python dependencies, and there are a few other dependencies which must be installed. See the platform-specific guides linked at the top of the page.
The recommended way to install the development version of Portmod is by pointing pip directly at the repository. Note that this version may be more unstable than the releases.
pip3 install git+https://gitlab.com/portmod/portmod
If you want to make changes to portmod, you probably want to instead create a local clone of the git repository and work with that version. See Developer Setup for Portmod for details.
Portmod requires Python 3.7 or later.
Since portmod 2.0 beta5, portmod compiles a rust extension using setuptools-rust and pyo3. As such, source installations of Portmod requires a rust compiler (1.62+). If you are installing using a pre-compiled wheel from pypi (which, as long as a wheel for your platform is available, is usually what is installed when using pip), you do not need a rust compiler to install.
Can be installed through pip, or via your package manager. When installing using the pip commands given later in this file these will be installed automatically.
Note that patool relies on helper programs to handle may file types, you will need these programs installed and in your PATH to be able to extract files of types not supported natively by patool (built-in types include TAR, ZIP, BZIP2 and GZIP). Archive types encountered by Portmod vary, but you probably want to have tools that can handle at least RAR, 7z and XZ archives.
The code in portmod using patool is now deprecated, but it is still technically a dependency. However, you don’t need to ensure that the helper tools are available unless you’re using a repository which still uses the legacy code.
progressbar2 >= 3.2
pywin32 - Windows only
RestrictedPython >= 4.0
importlib_metadata (for python 3.7)
fasteners >= 0.16
Portmod also includes sphinx documentation. This can produce a number of different output formats. On Linux and macOS, portmod will build man pages if sphinx and sphinx-argparse are available.
To build other formats, you can use sphinx-build within the doc directory, or invoke sphinx-build via the included Makefile.
make -C doc html man
The following python dependencies are required to build the documentation:
sphinx_rtd_theme (html only)
sphinx-autodoc-typehints (html only)
Optional Installation Details
Command Line Completion
Portmod supports command line tab completion using
argcomplete. Since Portmod
uses entry points, the global autocompletion used by argcomplete doesn’t
work, so you need to register scripts individually by including the
following line in
eval "$(register-python-argcomplete portmod)"
Other Supported shells include (see argcomplete readme for details):
git bash (I.e. for Windows. Requires additional configuration compared to regular bash shells)
Portmod includes an optional GUI which requires PySide6-Essentials.
To install PySide6, you can either run pip install PySide6, install it with Portmod (i.e. pip install portmod[gui]), or build it yourself.