diff --git a/README.rst b/README.rst index 15d81bdd..b5b4f711 100644 --- a/README.rst +++ b/README.rst @@ -32,6 +32,8 @@ Python 3.8 or later is needed. Using pip to install LinkChecker: ``pip3 install linkchecker`` +pipx can also be used to install LinkChecker. + The version in the pip repository may be old, to find out how to get the latest code, plus platform-specific information and other advice see `doc/install.txt`_ in the source code archive. diff --git a/doc/install.txt b/doc/install.txt index 87e768df..6dae2742 100644 --- a/doc/install.txt +++ b/doc/install.txt @@ -37,13 +37,16 @@ used. .. _venv: https://docs.python.org/3/library/venv.html#creating-virtual-environments -Setup with pip +Setup with pip(x) ------------------ -pip_ can be used to install LinkChecker on the local system. +pip_ or pipx_ can be used to install LinkChecker on the local system. To install the latest release from PyPI: ``pip3 install linkchecker`` +or: +``pipx install linkchecker`` + There is no need to wait for releases, every update to LinkChecker gets a unique version number and is subjected to the test suite. You can easily install the latest source from the LinkChecker GitHub repository. @@ -55,6 +58,8 @@ Then: .. _pip: https://pypi.org/project/pip/ +.. _pipx: https://pypi.org/project/pipx/ + Setup for Windows ----------------- Python from the Microsoft Store does include pip_, but installing @@ -70,9 +75,9 @@ https://pip.pypa.io/en/stable/installation/ Setup for GNU/Linux ------------------- On all major Linux distributions (Debian, Mandriva, Redhat, Suse, Ubuntu), -the ``linkchecker`` package is available for installation. pip_ will be -available, often as a package e.g. ``python3-pip``, to install the latest -LinkChecker. +the ``linkchecker`` package is available for installation. +To install the latest LinkChecker pip_ will be available, often as a package +e.g. ``python3-pip``, a pipx_ package may also be found e.g. ``pipx``. You may wish to install your distribution's copies of LinkChecker's dependencies before using pip to install LinkChecker. e.g. for Debian/Ubuntu: @@ -81,6 +86,10 @@ before using pip to install LinkChecker. e.g. for Debian/Ubuntu: If those packages are too old pip will install newer versions. +To use the dependencies from your distribution if installing LinkChecker with pipx: + +`'pipx install --system-site-packages linkchecker`` + Manual setup for Unix systems ----------------------------- First, install the required software.