如果我正在制作 pip 模块,需要将哪些文件上传或添加到 git 存储库
What files need to be uploaded or added to the git repository if I'm making a pip module
我最近制作了一个开源 pip 模块,我发布它的是 PyPI。我知道在 PyPI 上,我可以使用 twine
直接发布模块 dist/*
文件夹,但我也想在 GitHub、Gitlab 和我自己组织的官方 git 上发布这个模块回购。所以,我想知道应该将哪些文件添加到 git
存储库?
src
文件夹: 这是我编码 python 模块的文件的主文件夹。
所以我应该上传 git 存储库:
- 所有文件(无
venv
文件夹)
dist
文件夹,src
文件夹,.gitinore
, LICENSE
, README.md
, setup.py
- 选项 (2) 没有
src
文件夹
- 选项 (2) 没有
dist
文件夹
您只需包含 src
文件夹、.gitinore
、LICENSE
、README.md
和 setup.py
。理想情况下,您总是希望在发布到 Pypi 之前重新构建,因此您不需要 dist
文件夹。
不过,我推荐使用依赖管理工具 poetry,它使用 pyproject.toml
而不是 setup.py
。它比老式的 setup.py
.
更易于阅读和管理
poetry 还允许使用单个命令将包发布到 Pypi poetry publish --build ...
。
我最近制作了一个开源 pip 模块,我发布它的是 PyPI。我知道在 PyPI 上,我可以使用 twine
直接发布模块 dist/*
文件夹,但我也想在 GitHub、Gitlab 和我自己组织的官方 git 上发布这个模块回购。所以,我想知道应该将哪些文件添加到 git
存储库?
src
文件夹: 这是我编码 python 模块的文件的主文件夹。
所以我应该上传 git 存储库:
- 所有文件(无
venv
文件夹) dist
文件夹,src
文件夹,.gitinore
,LICENSE
,README.md
,setup.py
- 选项 (2) 没有
src
文件夹 - 选项 (2) 没有
dist
文件夹
您只需包含 src
文件夹、.gitinore
、LICENSE
、README.md
和 setup.py
。理想情况下,您总是希望在发布到 Pypi 之前重新构建,因此您不需要 dist
文件夹。
不过,我推荐使用依赖管理工具 poetry,它使用 pyproject.toml
而不是 setup.py
。它比老式的 setup.py
.
poetry 还允许使用单个命令将包发布到 Pypi poetry publish --build ...
。