如何使用 Twine 模块在 PyPi 上发布Python包?
Python非常灵活且易于使用,因为它的可用包托管在 pypi.org 上,让我们看看如何使用Twine模块在 PyPi 上发布您自己的包。
要求:
- 你必须有pypi.org的账号,如果不创建账号
- 创建twine库是为了简化在pypi中上传包。安装麻线库。
pip install twine
- 准备好你的包裹。
发布包的步骤:
第 1 步:准备和整理包裹
- 创建文件夹名称必须与包名称相同。 (确保你的包名不预先存在于 PyPi 中)
- 在此创建另一个具有相同名称或相同包名称的文件夹,其中将所有.py文件与单个强制__init__.py文件一起放置,并且所有文件夹/程序必须在__init__.py 中导入。
- 现在在程序文件夹外和根文件夹内,必须创建Setup.py文件、 README.md文件和Liscense.txt文件。下面是层次结构的流程图:
对于子文件夹akshaypawar-tut :
第 2 步:创建README.md文件
.md文件是标记文件,就像标记语言一样,它有自己的语法,用作用户友好的自述文件,将显示在主页上。
您可以使用 VS Code 的扩展或任何在线编辑器(如 https://dillinger.io/)来创建 Readme.md 。
步骤 3:创建License.txt文件
你的包必须有许可证,如果你不担心在世界各地共享它,你可以使用 License.txt。如果您的软件包有政策,您可以使用任何在线许可证制造商网站,例如 https://choosealicense.com/。
第 4 步:创建Setup.py文件
你的包必须有一个Setup.py文件,因为它是包的绑定组件之一,它描述了包的依赖关系和作者版本等。
下面是通用Setup.py 的代码。一个需要使用他们自己的凭据。
Python3
import setuptools
with open("README.md", "r") as fh:
long_description = fh.read()
setuptools.setup(
# Here is the module name.
name="akshaypawar_tut",
# version of the module
version="0.0.1",
# Name of Author
author="Akshay Pawar",
# your Email address
author_email="akshaygpawar15@gmail.com",
# #Small Description about module
# description="adding number",
# long_description=long_description,
# Specifying that we are using markdown file for description
long_description=long_description,
long_description_content_type="text/markdown",
# Any link to reach this module, ***if*** you have any webpage or github profile
# url="https://github.com/username/",
packages=setuptools.find_packages(),
# if module has dependecies i.e. if your package rely on other package at pypi.org
# then you must add there, in order to download every requirement of package
# install_requires=[
# "package1",
# "package2",
# ],
license="MIT",
# classifiers like program is suitable for python3, just leave as it is.
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
)
第 5 步:最后阶段
在这里,您必须在 pypi.org 上创建帐户,我们还将使用twine库。整个包以.dist文件的形式上传。
要创建.dist文件使用命令:
# Windows
python setup.py bdist_wheel
或者
# Linux/Mac
python3 setup.py bdist_wheel
执行上述命令时,您将在 Powershell 上观察到此消息。
现在我们的二进制.dist文件已创建,现在我们需要使用以下命令上传它:
twine upload dist/*
输入有关pypi.org帐户所需的凭据,程序包将被上传。
成功上传后,您将获得项目的链接和所有详细信息
单击此处查看文章中讨论的上传包。