python - 使用 Python 包管理器 Poetry 时，我应该将哪些文件/目录添加到 .gitignore？

Question

我正在使用一个非常新的 Python 包管理器，名为 Poetry。 .

它会在创建新项目(环境)时创建多个文件/目录，但我不确定应该将哪个添加到 .gitignore以获得最佳实践。

假设我通过这样做创建了一个新的诗歌项目:

$ poetry new foo_project
$ cd foo_project
$ poetry add numpy
$ ls

有:

tests (directory)
foo_project (also a directory)
pyproject.toml (a file that specifies installed packages)
poetry.lock (a lock file of installed packages)
README.rst (I don't know why README is created but it just shows up.)

我通常加 tests/ , foo_project/ , poetry.lock和 README.rst因为它们似乎依赖于创建项目的机器。另外，我似乎只能用 pyproject.toml 重现环境。所以这是我忽略所有其他文件/目录的另一个原因。

然而，这只是我的预感，不幸的是，我找不到任何官方指南我真正应该添加到 .gitignore在官方文档上。

我不知道自己在做什么，这让我很烦恼。我应该添加哪些到我的 .gitignore ?

Answer 1

最近也转向诗歌。
我会说你不应该添加任何:tests/ , foo_project/ , poetry.lock或 README.rst给您的.gitignore .换句话说，这些文件和文件夹应该在版本控制中。我的理由如下:tests/ - 你的测试不应该依赖于机器(除非这是你的包的已知限制)并且为其他人提供测试是他们测试的方式a)安装已经工作并且b)他们所做的任何更改都不会破坏过去的功能，所以拉取请求变得更加健壮。foo_project/ - 这就是你的 python 模块所在的地方!如果您希望诗歌能够构建和发布您的包，您所有的 .py 文件都应该在此文件夹中。poetry.lock - 见 https://python-poetry.org/docs/basic-usage/它说:

When Poetry has finished installing, it writes all of the packages and the exact versions of them that it downloaded to the poetry.lock file, locking the project to those specific versions. You should commit the poetry.lock file to your project repo so that all people working on the project are locked to the same versions of dependencies (more below).

README.rst - 虽然这个可能更个人化，但如果你使用诗歌来发布你的包，这个文件就会成为你的包自述文件，例如到 PyPi。没有它，你的包将有一个空的自述文件。我有两个自述文件，一个 .md(用于 GitHub)和一个 .rst(用于 PyPi)。我为开发人员/用户使用 GitHub 自述文件，为纯用户使用 PyPi。