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

Question

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

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

所以我应该在 git 存储库上上传：

1. 所有文件（无venv文件夹）
2. dist文件夹，文件夹src，，，，，，.gitinoreLICENSEREADME.mdsetup.py
3. 不带 文件夹的选项(2)src
4. 不带 文件夹的选项(2)dist

标签： pythongitmodulepipgitignore

Answer 1

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

但是，我建议使用依赖管理工具诗歌，它使用 apyproject.toml而不是setup.py. 它比老式的setup.py.

诗歌还允许使用单个命令将您的包发布到 Pypi poetry publish --build ...。