您已经创建了一个Python项目,并且渴望与他人分享。但是首先,您必须打包!本教程将为您介绍如何打包简单的Python项目。它将向您展示如何添加必要的文件和结构以创建软件包,如何构建软件包以及如何将其上传到PYPI。
环境设置:
- PIP升级:将PIP版本更新为最新版本:
python3 -m pip install --upgrade pip
- twine :安装麻线(https://pypi.org/project/twine/),这是在PYPI上发布Python软件包的实用程序。
pip install twine
- Wheel :让我们安装轮子(https://pypi.org/project/wheel/),这是PEP 427中定义的Python Wheel包装标准的参考实现。
pip install wheel
Python项目和结构:
让我们创建一个小型项目以上传到PYPI。
我一直在寻找一个想法来解释包装,我在看着朋友,所以想着周围创建一些东西。
所以让我们命名项目FriendsPy
(不是朋友间谍:D)。
创建一个新文件夹名称IT FriendsPy
。在文件夹下,我们需要以下结构:
FriendsPy/
├── friendspy/
│ ├── qoutes/
│ ├── __init__.py
├── setup.py
├── README.md
setup.py
将容纳所有必需的属性,以将软件包上传到PYPI。
示例文件将具有以下内容:
from setuptools import setup
VERSION = '0.0.1'
DESCRIPTION = 'Friends Show Related API'
LONG_DESCRIPTION = 'A package that allows to get details about friends show'
# Setting up
setup(
name="friendspy",
version=VERSION,
author="Ashutosh Sharma",
author_email="email2ashusharma@gmail.com",
description=DESCRIPTION,
long_description_content_type="text/markdown",
long_description=LONG_DESCRIPTION,
packages = ['friendspy.qoutes'], # this should have the list of packages we want to expose
install_requires=[],
keywords=['python', 'friends', 'entertainment', 'fun'],
classifiers=[
"Development Status :: 1 - Planning",
"Intended Audience :: Developers",
"Programming Language :: Python :: 3",
"Operating System :: Unix",
"Operating System :: MacOS :: MacOS X",
"Operating System :: Microsoft :: Windows",
]
)
让我们在__init__.py
文件下创建一个方法,该方法可以由他人使用:
def random():
return "How you doin'?"
构建包装:
现在我们必须使用以下方式打包完整的项目
python setup.py sdist bdist_wheel
它将创建一个dist
文件夹,该文件夹将具有PYPI兼容的软件包。
上传到PYPI:
要上传此软件包,我们必须在命令下运行:
twine upload dist/*
它将要求您提供PYPI网站的用户名和密码。经过身份验证后,它将上传到PYPI。
github存储库:https://github.com/ashusharmatech/friendspy
pypi:https://pypi.org/project/friendspy/
使用此库:
安装最新版本的软件包:
pip install friendspy==0.0.2
在PY文件中导入项目,然后调用方法:
import friendspy.qoutes as qoutes
print(qoutes.random())
它将打印:
How you doin'?