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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<div align="center">
# PDM
一个现代的 Python 包管理器，支持 PEP 最新标准。[English version README](README.md)
[](https://pdm-project.org)
[](https://twitter.com/pdm_project)
[](https://discord.gg/Phn8smztpv)
[](https://pypi.org/project/pdm)
[](https://repology.org/project/pdm/versions)
[](https://pepy.tech/project/pdm)
[](https://pdm-project.org)
[](https://asciinema.org/a/jnifN30pjfXbO9We2KqOdXEhB)
</div>
## 这个项目是啥?
PDM 旨在成为下一代 Python 软件包管理工具。它最初是为个人兴趣而诞生的。如果你觉得 `pipenv` 或者
`poetry` 用着非常好，并不想引入一个新的包管理器，那么继续使用它们吧；但如果你发现有些东西这些
工具不支持，那么你很可能可以在 `pdm` 中找到。
## 主要特性
- 一个简单且相对快速的依赖解析器，特别是对于大的二进制包发布。
- 兼容 [PEP 517] 的构建后端，用于构建发布包(源码格式与 wheel 格式)
- 灵活且强大的插件系统
- [PEP 621] 元数据格式
- 功能强大的用户脚本
- 支持从 [indygreg's python-build-standalone](https://github.com/indygreg/python-build-standalone) 安装 Python。
- 像 [pnpm] 一样的中心化安装缓存，节省磁盘空间
[pep 517]: https://www.python.org/dev/peps/pep-0517
[pep 621]: https://www.python.org/dev/peps/pep-0621
[pnpm]: https://pnpm.io/motivation#saving-disk-space-and-boosting-installation-speed
## 与其他包管理器的比较
### [Pipenv](https://pipenv.pypa.io)
Pipenv 是一个依赖管理器，它结合了 `pip` 和 `venv`，正如其名称所暗示的。它可以从一种自定义格式文件 `Pipfile.lock` 或 `Pipfile` 中安装软件包。
然而，Pipenv 并不处理任何与构建、打包和发布相关的工作。所以它只适用于开发不可安装的应用程序（例如 Django 网站）。
如果你是一个库的开发者，无论如何你都需要 `setuptools`。
### [Poetry](https://python-poetry.org)
Poetry 以类似于 Pipenv 的方式管理环境和依赖，它也可以从你的代码构建 `.whl` 文件，并且可以将轮子和源码发行版上传到 PyPI。
它有一个漂亮的用户界面，用户可以通过贡献插件来定制它。Poetry 使用 `pyproject.toml` 标准。
### [Hatch](https://hatch.pypa.io)
Hatch 也可以管理环境（它允许每个项目有多个环境，但不允许把它们放在项目目录中），并且可以管理包（但不支持 lockfile）。Hatch 也可以用来打包一个项目（用符合 PEP 621 标准的 `pyproject.toml` 文件）并上传到 PyPI。
### 本项目
PDM 也可以像 Pipenv 那样在项目或集中的位置管理 venvs。它从一个标准化的 `pyproject.toml` 文件中读取项目元数据，并支持 lockfile。用户可以在插件中添加更多的功能，并将其作为一个发行版上传，以供分享。
此外，与 Poetry 和 Hatch 不同，PDM 并没有被和一个特定的构建后端绑定，你可以选择任何你喜欢的构建后端。
## 安装
<a href="https://repology.org/project/pdm/versions">
<img src="https://repology.org/badge/vertical-allrepos/pdm.svg" alt="Packaging status" align="right">
</a>
PDM 需要 Python 3.9 或更高版本。
### 通过安装脚本
像 pip 一样，PDM 也提供了一键安装脚本，用来将 PDM 安装在一个隔离的环境中。
**Linux/Mac 安装命令**
```bash
curl -sSL https://pdm-project.org/install-pdm.py | python3 -
```
**Windows 安装命令**
```powershell
powershell -ExecutionPolicy ByPass -c "irm https://pdm-project.org/install-pdm.py | py -"
```
为安全起见，你应该检查 `install-pdm.py` 文件的正确性。
校验和文件下载地址：[install-pdm.py.sha256](https://pdm-project.org/install-pdm.py.sha256)
默认情况下，此脚本会将 PDM 安装在 Python 的用户目录下，具体位置取决于当前系统：
- Unix 上是 `$HOME/.local/bin`
- MacOS 上是 `$HOME/Library/Python/<version>/bin`
- Windows 上是 `%APPDATA%\Python\Scripts`
你还可以通过命令行的选项来改变安装脚本的行为：
```
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
```
你既可以通过直接增加选项，也可以通过设置对应的环境变量来达到这一效果。
### 其他安装方法
如果你使用的是 macOS 并且安装了 `homebrew`：
```bash
brew install pdm
```
如果你在 Windows 上使用 [Scoop](https://scoop.sh/), 运行以下命令安装：
```
scoop bucket add frostming https://github.com/frostming/scoop-frostming.git
scoop install pdm
```
否则，强烈推荐把 `pdm` 安装在一个隔离环境中， 用 `pipx` 是最好的。
```bash
pipx install pdm
```
或者你可以将它安装在用户目录下:
```bash
pip install --user pdm
```
[asdf-vm](https://asdf-vm.com/)
```bash
asdf plugin add pdm
asdf install pdm latest
```
## 快速上手
**初始化一个新的 PDM 项目**
```bash
pdm init
```
按照指引回答提示的问题，一个 PDM 项目和对应的`pyproject.toml`文件就创建好了。
**添加依赖**
```bash
pdm add requests flask
```
你可以在同一条命令中添加多个依赖。稍等片刻完成之后，你可以查看`pdm.lock`文件看看有哪些依赖以及对应版本。
## 徽章
在 README.md 中加入以下 Markdown 代码，向大家展示项目正在使用 PDM:
```markdown
[](https://pdm-project.org)
```
[](https://pdm-project.org)
## PDM 生态
[Awesome PDM](https://github.com/pdm-project/awesome-pdm) 这个项目收集了一些非常有用的 PDM 插件及相关资源。
## 赞助
<p align="center">
<a href="https://cdn.jsdelivr.net/gh/pdm-project/sponsors/sponsors.svg">
<img src="https://cdn.jsdelivr.net/gh/pdm-project/sponsors/sponsors.svg"/>
</a>
</p>
## 鸣谢
本项目的受到 [pyflow] 与 [poetry] 的很多启发。
[pyflow]: https://github.com/David-OConnor/pyflow
[poetry]: https://github.com/python-poetry/poetry
## 使用许可
本项目基于 MIT 协议开源，具体可查看 [LICENSE](LICENSE)。
|
