封装代码成python包

  |  

注册账户

PyPI, Python Package Index,是 python 的正式第三方软件包的软件存储库。一些软件包管理器如 pip,就是默认从 PyPI 下载软件包

链接: https://pypi.org/

在 Pypi 中注册账号,并且需要激活邮箱

更新 pip

python -m pip install --upgrade pip

安装 pipenv

pip install pipenv

使用 pyCharm 创建项目

选择 pipenv
在这里插入图片描述
在当前项目目录执行 pipenv install,初始化后项目如下

在这里插入图片描述

创建包名 mypackage

注意:包名尽量不要用驼峰和中划线做包名,不然容易出现找不到包名
在这里插入图片描述

创建 setup.py 用于编译包配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import setuptools

with open("README.md", "r", encoding="utf-8") as f:
readme = f.read()

requires = [
"requests>=2.28.1",
]

setuptools.setup(
name="mypackage",
version="1.0.0",
keywords=["关键词1", "关键词2", "关键词3"],
author="开发者",
author_email="开发者邮箱",
description="描述",
long_description=readme,
long_description_content_type="text/markdown",
url="项目githup地址",
packages=setuptools.find_packages(exclude=('tests', '.pypirc')),
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
],
python_requires='>=3.7',
install_requires=requires,
)

注意:install_requires 是你当前包需要的外部引入,需要在这里声明,不然其他人用你当前包会出现缺少引入

配置 pypi 密码

创建 .pypirc 防止你电脑的用户目录下:C:\Users\klover,因为 setup.py 上传指令会检查.pypirc 文件是否存在在路径 $HOME/.pypirc 中。

1
2
3
4
5
6
7
8
[distutils]
index-servers =
pypi

[pypi]
repository: <repository-url>
username: <username>
password: <password>

编译

1
2
3
4
# 编译
# 执行当前命令需要移除 build dist mypackage.egg-info 三个文件夹连同里面的文件

python setup.py sdist bdist_wheel

上传

1
twine upload dist/*

上传成功就能在 pypi 上看见了

文档

Pypi 官方教程中文版:封装代码成 python 包

文章目录
  1. 1. 注册账户
  2. 2. 更新 pip
  3. 3. 安装 pipenv
  4. 4. 使用 pyCharm 创建项目
  5. 5. 创建包名 mypackage
  6. 6. 创建 setup.py 用于编译包配置
  7. 7. 配置 pypi 密码
  8. 8. 编译
  9. 9. 上传
  10. 10. 文档