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#
PDM requires python version 3.7 or higher.
Like Pip, PDM provides an installation script that will install PDM into an isolated environment.
The installer will install PDM into the user site and the location depends on the system:
You can pass additional options to the script to control how PDM is installed:
1 2 3 4 5 6 7 8 9 10
You can either pass the options after the script or set the env var value.
Other installation methods#
If your are on MacOS and using
homebrew, install it by:
If you are on Windows and using Scoop, install it by:
Otherwise, to avoid messing up with the system Python environment, the most recommended way to install PDM is via pipx:
Or you can install PDM into the 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.
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 the following to
1 2 3 4 5
Enable PEP582 globally, and make sure VSCode runs using the same user and shell you enabled PEP582 for.
Cannot enable PEP582 globally?
If for some reason you cannot enable PEP582 globally, you can still configure each "launch" in each project:
PYTHONPATH environment variable in your launch configuration, in
For example, to debug your
1 2 3 4 5 6 7 8 9 10 11 12 13 14
If your package resides in a
src directory, add it to
PYTHONPATH as well:
In addition, there is a VSCode Task Provider extension available for download.
Awesome PDM is a curated list of awesome PDM plugins and resources.