将模块发布到pip和PyPi

Question

我用python创建了一个模块。我想把它发布到pip和PyPi以便其他人可以轻松下载和使用它。我该怎么做？在

Answer 1

答案很容易在网上找到。我刚才提到this site来回答你。您可以按照以下步骤操作：

1. 在^{}上创建帐户。

2. 创建一个README.md文件作为用户的说明（强烈建议）。

3. 创建一个setup.cfg文件，并编写以下内容：

[metadata]
description-file = README.md

1. 通过引用this website创建一个LICENSE文件。

2. 正如@Yang HG提到的，编写一个setup.py文件，然后运行python setup.py sdist。

3. 使用twine上载您的发行版。首先，您需要pip install twine，然后运行twine upload dist/*。

最后，您的发行版可以在https://pypi.org/project/YOURPACKAGENAME/上查看

Answer 2

这在Packaging Python Projects中有详细说明。在

创造自述文件.md在

创建一个名为README.md的文件，并根据需要编辑它（在Markdown中）。在

正在创建setup.py

setup.py是setuptools的构建脚本。它告诉setuptools关于您的包（例如名称和版本）以及要包含哪些代码文件。在

import setuptools

with open("README.md", "r") as fh:
    long_description = fh.read()

setuptools.setup(
    name="example-pkg-your-username",
    version="0.0.1",
    author="YOUR NAME",
    author_email="YOUR EMAIL",
    description="A small example package",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/pypa/sampleproject",
    packages=setuptools.find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
)

创建许可证

创建一个名为LICENSE的文件，并从here中选择内容。在

生成分发档案

下一步是为包生成分发包。这些是上传到包索引的归档文件，可以由pip安装。 我们首先需要确保安装了wheel和{}：

^{pr2}$

现在我们需要从setup.py所在的同一目录中运行以下命令：

python3 setup.py sdist bdist_wheel

上传分发档案

建议在实际的PyPi之前上传到TestPyPi尽管我将不介绍这一部分。 以下步骤说明如何将包上载到PyPi：

1. 安装twine：

python3 -m pip install  user  upgrade twine

1. 注册到PyPi。在
2. 运行twine将dist包上载到PyPi：

python3 -m twine upload dist/*