python - 如果我正在制作 pip 模块，需要上传或添加哪些文件到 git 存储库

Question

我最近制作了一个开源 pip 模块，我并发布它是 PyPI。我知道在 PyPI 上，我可以使用 twine 直接发布模块 dist/* 文件夹，但我也想在 GitHub、Gitlab 和我自己组织的官方 git 上发布这个模块 repo 。所以，我想知道应该将哪些文件添加到 git 存储库中？

src 文件夹:这是我编写 python 模块的文件的主文件夹。

那么我应该在 git 存储库上上传:

1. 所有文件(无 venv 文件夹)
2. dist 文件夹、src 文件夹、.gitinore、LICENSE、README.md、setup.py
3. 没有src文件夹的选项(2)
4. 没有dist文件夹的选项(2)

Answer 1

您只需包含 src 文件夹、.gitinore、LICENSE、README.md 和setup.py。理想情况下，您总是希望在发布到 Pypi 之前重新构建，因此您不需要 dist 文件夹。

但是，我建议使用依赖管理工具 poetry ，它使用 pyproject.toml 而不是 setup.py。它比老式的 setup.py 更易于人类阅读和管理。

poetry 还允许使用单个命令 poetrypublish --build ... 将包发布到 Pypi。