Python實現在PyPI上發佈自定義軟件包的方法詳解

Posted on by

1. 引言

在Python中我們經常使用pip來安裝第三方Python軟件包，其實我們每個人都可以免費地將自己寫的Python包發佈到PyPI上，供他人來通過pip進行安裝。

在本文中，我們將從一步一步地詳細介紹如何發佈測試包。

2. 創建PyPI賬號

網址： https://pypi.org/

我們可以通過上面的鏈接在PyPI官網免費創建一個帳戶。

我們需要先創建一個帳戶，然後才能發佈測試包。

3. 創建包名

我們可以發佈任意我們想要定義的包名，隻要和以前發佈過的包沒有重名過。我們可以快速在網站PyPI上檢查是否有同名包。為瞭方便示例，我們使用aiway來作為示例的包名。

4. 按照如下格式組織包

需要註意的是我們可以使用任意我們想要發佈的包名來替換上述aiway包名。

上述腳本 src/aiway/__init__.py內容如下：

def function():
    print("hello from src/aiway/__init__.py")

腳本 src/aiway/test.py內容如下：

def testfunction():
    print("hello from src/aiway/test.py")

腳本LICENSE: 我們這裡留白

腳本README.md： 這裡可以描述包的用途

腳本pyproject.toml，內容如下：

[build-system]
requires = ["setuptools>=42"]
build-backend = "setuptools.build_meta"

我們必須創建該文件

腳本 setup.py，內容如下：

from time import time
import setuptools
with open("README.md", "r", encoding="utf-8") as fh:
    long_description = fh.read()
setuptools.setup(
    name="aiway",
    version="0.0.0",
    author="Your Name Goes Here",
    author_email="[email protected]",
    description="A test package",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/pypa/sampleproject",
    project_urls={
        "Bug Tracker": "https://github.com/pypa/sampleproject/issues",
    },
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    package_dir={"": "src"},
    packages=setuptools.find_packages(where="src"),
    python_requires=">=3.6",
)

5. 安裝 Build & Twine

接著我們通過pip來安裝我們的依賴包，命令如下：

pip install build twine

我們需要用到上述兩個包來將我們的測試包推送到PyPI。安裝過程如下:

6. 構建測試包

接著我們來編譯我們的測試包，命令如下：

python -m build

在將包上載到PyPI之前，我們需要首先使用build構建它。上述命令的輸出如下：

上述命令運行完成後，我們將會得到目錄dist 以及 格式為 <package-name>.egg-info的包。如下所示：

7. 上傳測試包

接著我們使用以下命令將包上傳，如下所示：

python -m twine upload dist/*

包twine用來將我們的測試包上傳至PyPI。上述命令執行過程中需要輸入我們註冊的網站的用戶名和密碼。如下所示：

同時我們可以在網站上看到我們上傳的包，如下：

如果我們隻是更新已經存在的包的版本，我們可以使用如下命令：

python -m twine upload dist/* --skip-existing

同時我們可以添加調試標志–verbose,來檢查上述命令執行過程中的出錯信息，如下：

python -m twine upload dist/* --skip-verbose

8. 總結

本文重點介紹瞭如何在PyPI上發佈自定義軟件包的流程，其中每一步都給出瞭詳細的解釋和圖解。

到此這篇關於Python實現在PyPI上發佈自定義軟件包的方法詳解的文章就介紹到這瞭,更多相關Python PyPI發佈自定義軟件包內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：