工程技术 | 如何在pypi上传开源项目

背景：对于Python项目，通常通过pypi将项目封装之后上传开源。好处是对于用户可以更方便的下载安装和使用。
目的：本文主要介绍了开源项目包含的文件结构以及如何将开源项目上传到pypi开源。

---

如何上传开源Python项目到pypi

• 创建setup.py文件
  setup.py主要包含一些项目的meta信息。
  可以借鉴pystk项目中setup.py的自动化获取一些信息的方式作为模板。

• 文件结构和文件内容

  • 文件结构
    
    
  • 文件内容
    官方使用方法文章看一遍基本就能了解各文件内容和相关参数含义

• 打包方式

  1. 确认安装setuptools和wheel

       python -m pip install --user --upgrade setuptools wheel
     

  2. 根据setup.py打包

       python setup.py sdist bdist_wheel
     

  生成的两个文件都在dist/文件夹中。
  第一个.tar.gz是source distribution，如果你的项目不是全平台兼容的，最好将源dist发布上去。
  第二个.whl是built distribution，是已经构建好的distribution。

• 上传方式

  1. 下载twine

      python3 -m pip install --user --upgrade twine
     

  如果你使用的是aconda包管理，则使用conda install twine

  2. 上传测试网站
     先在测试网站上进行上传测试和查看。

      twine upload --repository-url https://test.pypi.org/legacy/ dist/*
     

     如果想要上传正式pypi网站，则：

      twine upload dist/*
     

---

参考文章

包管理工具历史