Package: pipx
pipx — Install and Run Python Applications in Isolated EnvironmentsDocumentation:https://pipx.pypa.ioSource Code:https://github.com/pypa/pipxFor comparison to other tools including pipsi, seeComparison to Other Tools.Install pipx[!NOTE] It is not recommended to installpipxviapipx. If you'd like to do this anyway, take a look at thepipx-in-pipxproject and read about the limitations there.On macOSbrew install pipx
pipx ensurepathUpgrade pipx withbrew update && brew upgrade pipx.On LinuxUbuntu 23.04 or abovesudo apt update
sudo apt install pipx
pipx ensurepathUbuntu 22.04 or belowpython3 -m pip install --user pipx
python3 -m pipx ensurepathUpgrade pipx withpython3 -m pip install --user --upgrade pipx.On Windowsinstall viaScoopscoop install pipx
pipx ensurepathUpgrade pipx withscoop update pipx.install via pip (requires pip 19.0 or later)# If you installed python using Microsoft Store, replace `py` with `python3` in the next line.
py -m pip install --user pipxIt is possible (even most likely) the above finishes with a WARNING looking similar to this:WARNING: The script pipx.exe is installed in `<USER folder>\AppData\Roaming\Python\Python3x\Scripts` which is not on PATHIf so, go to the mentioned folder, allowing you to run the pipx executable directly. Enter the following line (even if
you did not get the warning):.\pipx.exe ensurepathThis will add both the above mentioned path and the%USERPROFILE%\.local\binfolder to your search path. Restart your
terminal session and verifypipxdoes run.Upgrade pipx withpy -m pip install --user --upgrade pipx.Using pipx without installing (via zipapp)You can also use pipx without installing it. The zipapp can be downloaded fromGithub releasesand you can invoke it with a Python 3.7+ interpreter:python pipx.pyz ensurepathUse with pre-commitpipxhas pre-commit support.Shell completionsShell completions are available by following the instructions printed with this command:pipx completionsFor more details, see theinstallation instructions.Overview: What ispipx?pipx is a tool to help you install and run end-user applications written in Python. It's roughly similar to macOS'sbrew, JavaScript'snpx, and
Linux'sapt.It's closely related to pip. In fact, it uses pip, but is focused on installing and managing Python packages that can be
run from the command line directly as applications.How is it Different from pip?pip is a general-purpose package installer for both libraries and apps with no environment isolation. pipx is made
specifically for application installation, as it adds isolation yet still makes the apps available in your shell: pipx
creates an isolated environment for each application and its associated packages.pipx does not ship with pip, but installing it is often an important part of bootstrapping your system.Where DoespipxInstall Apps From?By default, pipx uses the same package index as pip,PyPI. pipx can also install from all other
sources pip can, such as a local directory, wheel, git url, etc.Python and PyPI allow developers to distribute code with "console script entry points". These entry points let users
call into Python code from the command line, effectively acting like standalone applications.pipx is a tool to install and run any of these thousands of application-containing packages in a safe, convenient, and
reliable way.In a way, it turns Python Package Index (PyPI) into a big app store for Python applications.Not all
Python packages have entry points, but many do.If you would like to make your package compatible with pipx, all you need to do is add aconsole scriptsentry point. If you're a poetry user, usethese instructions. Or
you're using hatch,try this.Featurespipxenables you toExpose CLI entrypoints of packages ("apps") installed to isolated environments with theinstallcommand. This
guarantees no dependency conflicts and clean uninstalls!Easily list, upgrade, and uninstall packages that were installed with pipxRun the latest version of a Python application in a temporary environment with theruncommandBest of all, pipx runs with regular user permissions, never callingsudo pip install(you aren't doing that, are you?
😄).Walkthrough: Installing a Package and its Applications WithpipxYou can globally install an application by runningpipx install PACKAGEThis automatically creates a virtual environment, installs the package, and adds the package's associated applications
(entry points) to a location on yourPATH. For example,pipx install pycowsaymakes thepycowsaycommand available
globally, but sandboxes the pycowsay package in its own virtual environment.pipx never needs to run as sudo to do
this.Example:>> pipx install pycowsay
  installed package pycowsay 2.0.3, Python 3.7.3
  These apps are now globally available
    - pycowsay
done! ✨ 🌟 ✨


>> pipx list
venvs are in /home/user/.local/share/pipx/venvs
apps are exposed on your $PATH at /home/user/.local/bin
   package pycowsay 2.0.3, Python 3.7.3
    - pycowsay


# Now you can run pycowsay from anywhere
>> pycowsay mooo
  ____
< mooo >
  ====
         \
          \
            ^__^
            (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||Installing from Source ControlYou can also install from a git repository. Here,blackis used as an example.pipx install git+https://github.com/psf/black.git
pipx install git+https://github.com/psf/black.git@branch  # branch of your choice
pipx install git+https://github.com/psf/black.git@ce14fa8b497bae2b50ec48b3bd7022573a59cdb1  # git hash
pipx install https://github.com/psf/black/archive/18.9b0.zip  # install a releaseThe pip syntax witheggmust be used when installing extras:pipx install "git+https://github.com/psf/black.git#egg=black[jupyter]"Inject a packageIf an application installed by pipx requires additional packages, you can add them with pipx inject. For example, if you haveipythoninstalled and want to add thematplotlibpackage to it, you would use:pipx inject ipython matplotlibWalkthrough: Running an Application in a Temporary Virtual EnvironmentThis is an alternative topipx install.pipx rundownloads and runs the above mentioned Python "apps" in a one-time, temporary environment, leaving your
system untouched afterwards.This can be handy when you need to run the latest version of an app, but don't necessarily want it installed on your
computer.You may want to do this when you are initializing a new project and want to set up the right directory structure, when
you want to view the help text of an application, or if you simply want to run an app in a one-off case and leave your
system untouched afterwards.For example, the blog postHow to set up a perfect Python projectusespipx runto kickstart a new project withcookiecutter, a tool
that creates projects from project templates.A nice side benefit is that you don't have to remember to upgrade the app sincepipx runwill automatically run a
recent version for you.Okay, let's see what this looks like in practice!pipx run APP [ARGS...]This will install the package in an isolated, temporary directory and invoke the app. Give it a try:> pipx run pycowsay moo

  ---
< moo >
  ---
   \   ^__^
    \  (oo)\_______
       (__)\       )\/\
           ||----w |
           ||     ||Notice that youdon't need to execute any install commands to run the app.Any arguments after the application name will be passed directly to the application:> pipx run pycowsay these arguments are all passed to pycowsay!

  -------------------------------------------
< these arguments are all passed to pycowsay! >
  -------------------------------------------
   \   ^__^
    \  (oo)\_______
       (__)\       )\/\
           ||----w |
           ||     ||Ambiguous argumentsSometimes pipx can consume arguments provided for the application:> pipx run pycowsay --py

usage: pipx run [-h] [--no-cache] [--pypackages] [--spec SPEC] [--verbose] [--python PYTHON]
                [--system-site-packages] [--index-url INDEX_URL] [--editable] [--pip-args PIP_ARGS]
                app ...
pipx run: error: ambiguous option: --py could match --pypackages, --pythonTo prevent this put double dash--before APP. It will make pipx to forward the arguments to the right verbatim to the
application:> pipx run -- pycowsay --py


  ----
< --py >
  ----
   \   ^__^
    \  (oo)\_______
       (__)\       )\/\
           ||----w |
           ||     ||Re-running the same app is quick because pipx caches Virtual Environments on a per-app basis. The caches only last a few
days, and when they expire, pipx will again use the latest version of the package. This way you can be sure you're
always running a new version of the package without having to manually upgrade.Package with multiple apps, or the app name doesn't match the package nameIf the app name does not match the package name, you can use the--specargument to specify thePACKAGEname, and
provide theAPPto run separately:pipx run --spec PACKAGE APPFor example, theesptoolpackage doesn't provide an executable with the same
name:>> pipx run esptool
'esptool' executable script not found in package 'esptool'.
Available executable scripts:
    esp_rfc2217_server.py - usage: 'pipx run --spec esptool esp_rfc2217_server.py [arguments?]'
    espefuse.py - usage: 'pipx run --spec esptool espefuse.py [arguments?]'
    espsecure.py - usage: 'pipx run --spec esptool espsecure.py [arguments?]'
    esptool.py - usage: 'pipx run --spec esptool esptool.py [arguments?]'You can instead run the executables that this package provides by using--spec:pipx run --spec esptool esp_rfc2217_server.py
pipx run --spec esptool espefuse.py
pipx run --spec esptool espsecure.py
pipx run --spec esptool esptool.pyNote that the.pyextension is not something you append to the executable name. It is part of the executable name, as
provided by the package. This can be anything. For example, when working with thepymodbuspackage:>> pipx run pymodbus[repl]
'pymodbus' executable script not found in package 'pymodbus'.
Available executable scripts:
    pymodbus.console - usage: 'pipx run --spec pymodbus pymodbus.console [arguments?]'
    pymodbus.server - usage: 'pipx run --spec pymodbus pymodbus.server [arguments?]'
    pymodbus.simulator - usage: 'pipx run --spec pymodbus pymodbus.simulator [arguments?]'You can run the executables like this:pipx run --spec pymodbus[repl] pymodbus.console
pipx run --spec pymodbus[repl] pymodbus.server
pipx run --spec pymodbus[repl] pymodbus.simulatorRunning a specific version of a packageThePACKAGEargument above is actually arequirement specifier. Therefore, you can
also specify specific versions, version ranges, or extras. For example:pipx run mpremote==1.20.0
pipx run --spec esptool==4.6.2 esptool.py
pipx run --spec 'esptool>=4.5' esptool.py
pipx run --spec 'esptool >= 4.5' esptool.pyNotice that some requirement specifiers have to be enclosed in quotes or escaped.Running from Source ControlYou can also run from a git repository. Here,blackis used as an example.pipx run --spec git+https://github.com/psf/black.git black
pipx run --spec git+https://github.com/psf/black.git@branch black  # branch of your choice
pipx run --spec git+https://github.com/psf/black.git@ce14fa8b497bae2b50ec48b3bd7022573a59cdb1 black  # git hash
pipx run --spec https://github.com/psf/black/archive/18.9b0.zip black # install a releaseRunning from URLYou can run .py files directly, too.pipx run https://gist.githubusercontent.com/cs01/fa721a17a326e551ede048c5088f9e0f/raw/6bdfbb6e9c1132b1c38fdd2f195d4a24c540c324/pipx-demo.py
pipx is working!SummaryThat's it! Those are the most important commandspipxoffers. To see all of pipx's documentation, runpipx --helpor
see thedocs.Testimonials"Thanks for improving the workflow that pipsi has covered in the past. Nicely done!"—Jannis Leidel, PSF fellow, former pip and Django core developer, and founder of the Python Packaging Authority (PyPA)"My setup pieces together pyenv, poetry, and pipx. [...] For the things I need, it’s perfect."—Jacob Kaplan-Moss, co-creator of Django in blog postMy Python Development Environment, 2020 Edition"I'm a big fan of pipx. I think pipx is super cool."—Michael Kennedy, co-host of PythonBytes podcast inepisode 139Creditspipx was inspired bypipsiandnpx. It was created
byChad Smithand has had lots of help fromcontributors. The logo was created by@IrishMorales.pipx is maintained by a team of volunteers (in alphabetical order)Bernát GáborChad Smith- co-lead maintainerJason LamMatthew Clapp- co-lead maintainerTzu-ping ChungContributingIssues and Pull Requests are definitely welcome! Check outContributingto
get started. Everyone who interacts with the pipx project via codebase, issue tracker, chat rooms, or otherwise is
expected to follow thePSF Code of Conduct.