第一步,新建文件夹
好的,我们先new一个项目,空文件夹就行,例如新建一个叫my-wheel的项目
第二步,写核心代码
新建一个mywheel的包,包下新建文件example.py
def msg():
return "a python lib named myWheel"
第三步,写setup.py文件
回到项目根目录,新建一个setup.py文件,写包主要是使用setuptools指明项目相关信息,以及打包相关配置,可以使用如下简单配置
from setuptools import setup, find_packages
setup(
# 项目名称
name="myWheel",
# 版本
version="1.0",
# 作者
author="yuzao",
# 作者邮箱
author_email="yuzao@xxx.com",
# 项目描述(简单描述)
description="A tutorial for writing a python lib",
# 项目主页
url="https://my-wheel.com/",
# 分类器
classifiers=[
# 开发状态
'Development Status :: 1 - Alpha',
# 开发的目标用户
'Intended Audience :: Developers',
# 主题
'Topic :: Software Development :: Build Tools',
# 许可证信息
'License :: OSI Approved :: MIT License',
# 目标 Python 版本
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
],
# python版本要求,不满足安装失败
python_requires='>=3.7',
# 你要安装的包,通过 setuptools.find_packages 寻找当前目录的包
packages=find_packages()
)
第四步,安装包
此时一个最简单的包就写完了,整体项目结构如下
在项目根目录下直接安装即可
python setup.py install
第五步,使用包
from mywheel.example import msg
print(msg())
# a python lib named myWheel
第六步,上传pypi
在pypi注册账号,并将自己的包上传,就可以使用pip进行安装了