Introduction#

PDMはPythonのパッケージと依存関係を管理する最新のPEP標準をサポートするマネージャーです。しかし、これは単なるパッケージマネージャではありません。さまざまな面で開発ワークフローを強化します。

Feature highlights#

主に大規模なバイナリ配布用の、シンプルで高速な依存関係のリゾルバ。
PEP 517ビルドバックエンド。
PEP 621プロジェクトメタデータ。
柔軟で強力なプラグイン方式です。
汎用性の高いユーザースクリプト。
indygreg's python-build-standaloneを使用したPythonのインストール。
pnpmのような集中インストールキャッシュ。

Installation#

PDMにはPython 3.8+がインストールされている必要があります。Windows、Linux、macOSなど複数のプラットフォームで動作します。

Note

プロジェクトを下位バージョンのPythonで動作させることもできます。その方法については、hereを参照してください。

Recommended installation method#

PDMにはPythonバージョン3.8以上が必要です。

Pipと同様に、PDMは、PDMを独立した環境にインストールするインストールスクリプトを提供します。

Linux/MacWindows

curl -sSL https://pdm-project.org/install-pdm.py | python3 -

(Invoke-WebRequest -Uri https://pdm-project.org/install-pdm.py -UseBasicParsing).Content | py -

Note

Windowsでは、オプションのpyランチャーツールがインストールされていない場合(MicrosoftストアからPythonをインストールした場合を含む)、pyをpythonに置き換えてください。

セキュリティ上の理由から、install-pdm.pyのチェックサムを確認するべきです。

install-pdm.py.sha256からダウンロードできます。

たとえば、Linux/Macの場合は次のようになります。

curl -sSLO https://pdm-project.org/install-pdm.py
curl -sSL https://pdm-project.org/install-pdm.py.sha256 | shasum -a 256 -c -
# Run the installer
python3 install-pdm.py [options]

インストーラはPDMをユーザーサイトにインストールします。インストール場所はシステムによって異なります。

$HOME/.local/bin Unixの場合
$HOME/Library/Python/<version>/bin MacOSの場合
%APPDATA%\Python\Scripts Windowsの場合

スクリプトに追加のオプションを渡して、PDMのインストール方法を制御できます。

usage: install-pdm.py [-h] [-v VERSION] [--prerelease] [--remove] [-p PATH] [-d DEP]

optional arguments:
  -h, --help            show this help message and exit
  -v VERSION, --version VERSION | envvar: PDM_VERSION
                        Specify the version to be installed, or HEAD to install from the main branch
  --prerelease | envvar: PDM_PRERELEASE    Allow prereleases to be installed
  --remove | envvar: PDM_REMOVE            Remove the PDM installation
  -p PATH, --path PATH | envvar: PDM_HOME  Specify the location to install PDM
  -d DEP, --dep DEP | envvar: PDM_DEPS     Specify additional dependencies, can be given multiple times

スクリプトの後にオプションを渡すか、env var値を設定します。

Other installation methods#

HomebrewScoopuvpipxpipasdfinside project

1	`brew install pdm`

scoop bucket add frostming https://github.com/frostming/scoop-frostming.git
scoop install pdm

uv tool install pdm

1	`pipx install pdm`

GitHubリポジトリのHEADバージョンをインストールします。システムにGit LFSがインストールされていることを確認します。

pipx install git+https://github.com/pdm-project/pdm.git@main#egg=pdm

すべての機能を含むPDMをインストールするには、次の手順に従います:

pipx install pdm[all]

Update the PDM version#

1	`pdm self update`

Packaging Status#

Shell Completion#

PDMは、Bash、Zsh、Fish、またはPowershellの補完スクリプトの生成をサポートしています。各シェルの一般的な場所を次に示します。

BashZshFishPowershell

pdm completion bash > /etc/bash_completion.d/pdm.bash-completion

# Make sure ~/.zfunc is added to fpath, before compinit.
pdm completion zsh > ~/.zfunc/_pdm

Oh-My-Zsh:

mkdir $ZSH_CUSTOM/plugins/pdm
pdm completion zsh > $ZSH_CUSTOM/plugins/pdm/_pdm

次に、pdmプラグインが~/.zshrcで有効になっていることを確認します。

pdm completion fish > ~/.config/fish/completions/pdm.fish

# Create a directory to store completion scripts
mkdir $PROFILE\..\Completions
echo @'
Get-ChildItem "$PROFILE\..\Completions\" | ForEach-Object {
    . $_.FullName
}
'@ | Out-File -Append -Encoding utf8 $PROFILE
# Generate script
Set-ExecutionPolicy Unrestricted -Scope CurrentUser
pdm completion powershell | Out-File -Encoding utf8 $PROFILE\..\Completions\pdm_completion.ps1

Virtualenv and PEP 582#

PDMは、virtualenv管理に加えて、オプトイン機能としてPEP 582を実験的にサポートしています。the Python Steering Council has rejected PEP 582が、PDMを使用してテストすることはできます。

2つのモードの詳細については、Working with virtualenvおよびWorking with PEP 582の関連する章を参照してください。

PDM Eco-system#

Awesome PDM はPDMのすばらしいプラグインとリソースを集めたリストです。