PDM is a modern Python package manager with PEP 582 support. It installs and manages packages
in a similar way to
npm that doesn't need to create a virtualenv at all!
- PEP 582 local package installer and runner, no virtualenv involved at all.
- Simple and relatively fast dependency resolver, mainly for large binary distributions.
- A PEP 517 build backend.
- PEP 621 project metadata.
PDM requires Python 3.7+ to be installed. It works on multiple platforms including Windows, Linux and MacOS.
There is no restriction about what Python version your project is using, but installing PDM itself needs Python 3.7+.
Recommended installation method#
If your are on MacOS and using
homebrew, install it by:
Otherwise, to avoid messing up with the system Python environment, the most recommended way to install PDM is via pipx:
Other installation methods#
Install PDM into user site with
Install the head version of GitHub repository:
Make sure you have installed Git LFS on your system.
Enable PEP 582 globally#
To make the Python interpreters aware of PEP 582 packages, one need to add the
to the Python library search path.
For Windows users#
One just needs to execute
pdm --pep582, then environment variable will be changed automatically. Don't forget
to restart the terminal session to take effect.
For Mac and Linux users#
The command to change the environment variables can be produced by
pdm --pep582 [<SHELL>]. If
isn't given, PDM will pick one based on some guesses.
You may want to write a line in your
.bash_profile(or similar profiles) to make it effective when login.
For example, in bash you can do this:
Once again, Don't forget to restart the terminal session to take effect.
This setup may become the default in the future.
Use the docker image#
PDM also provides a docker image to ease your deployment flow, to use it, write a Dockerfile with following content:
1 2 3 4 5 6
PDM supports generating completion scripts for Bash, Zsh, Fish or Powershell. Here are some common locations for each shell:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
Unicode and ANSI supports#
PDM provides a fancy terminal UI with the help of ANSI characters and unicode emojis.
It can turn on/off automatically depending on whether it is supported on your terminal.
However, if you see any garbled characters, set env var
DISABLE_UNICODE_OUTPUT=1 to turn off it.
Use with IDE#
Now there are not built-in support or plugins for PEP 582 in most IDEs, you have to configure your tools manually.
PDM will write and store project-wide configurations in
.pdm.toml and you are recommended to add following lines
__pypackages__/<major.minor>/lib as Sources Root.
Additionally, if you want to use tools from the environment (e.g.
pytest), you have to add the
__pypackages__/<major.minor>/bin directory to the
PATH variable in the corresponding
Add following in the
1 2 3 4 5
In addition, there is a VSCode Task Provider extension available for download.