摘要:自己寫一個python模塊如何讓別人通過使用pip install
命令安裝?
概括:創建項目;配置文件;注冊一個賬號;使用兩行命令發布模塊;完成。
創建自己的項目
項目結構
deeplearntool/ deeplearn/ __init__.py tests __init__.py setup.py
主目錄是整個包的根目錄,setup.py是部署到pip需要的配置文件,子目錄deeplearn是真正的python代碼位置。
在__init__.py
中寫入代碼:
def start(): print("import successful")
然后在setup.py
文件中寫入以下配置信息(參數里的內容可以修改,可以添加的參數具體可以參考python官方文檔)
import setuptools setuptools.setup(name='deeplearnt', version='0.0.2', description='clinical trial information retriver', url='github項目地址 https://github.com/pergrand/deeplearntool', author='用戶名', author_email='郵箱', license='MIT', packages=setuptools.find_packages(), zip_safe=False)
准備發布
第一步
setup.py配置文件中的 author 需要在PyPI官網中注冊:登錄官網,在右邊菜單點擊Register,注冊一個賬號。
將用戶名寫入setup.py配置文件中
第二步
項目上傳github;這一步貼出一個鏈接吧(測試過可用)
https://blog.csdn.net/longgeaisisi/article/details/78012406
發布python模塊
第一步
到項目根目錄目錄,輸入:
python setup.py sdist
這個命令會在根目錄創建dist目錄,並且會根據配置文件中的信息創建對應版本的壓縮文件。
第二步
然后輸入命令,上傳文件:
python setup.py sdist upload
這個命令會根據配置文件信息,將dist下對應的壓縮文件上傳。
上傳成功后查看 https://pypi.org/project/deeplearnt/#history
pip下載驗證
pip install deeplearnt
如果源更換了,使用 pip install -i https://pypi.org/project deeplearnt
注:deeplearnt 是配置文件中name的名字