背景:對于Python項目,通常通過pypi將項目封裝之后上傳開源淘钟。好處是對于用戶可以更方便的下載安裝和使用宦赠。
目的:本文主要介紹了開源項目包含的文件結(jié)構(gòu)以及如何將開源項目上傳到pypi開源。
如何上傳開源Python項目到pypi
-
創(chuàng)建setup.py文件
setup.py主要包含一些項目的meta信息。
可以借鑒pystk項目中setup.py的自動化獲取一些信息的方式作為模板勾扭。
-
文件結(jié)構(gòu)和文件內(nèi)容
-
文件結(jié)構(gòu)
-
文件內(nèi)容
官方使用方法文章看一遍基本就能了解各文件內(nèi)容和相關(guān)參數(shù)含義
-
文件結(jié)構(gòu)
-
打包方式
-
確認安裝setuptools和wheel
python -m pip install --user --upgrade setuptools wheel
-
根據(jù)setup.py打包
python setup.py sdist bdist_wheel
生成的兩個文件都在dist/文件夾中毡琉。
第一個.tar.gz是source distribution,如果你的項目不是全平臺兼容的妙色,最好將源dist發(fā)布上去桅滋。
第二個.whl是built distribution,是已經(jīng)構(gòu)建好的distribution身辨。 -
-
上傳方式
-
下載twine
python3 -m pip install --user --upgrade twine
如果你使用的是aconda包管理丐谋,則使用conda install twine
-
上傳測試網(wǎng)站
先在測試網(wǎng)站上進行上傳測試和查看。twine upload --repository-url https://test.pypi.org/legacy/ dist/*
如果想要上傳正式pypi網(wǎng)站煌珊,則:
twine upload dist/*
-