要将 Python 源代码打包成可供他人通过 pip 安装的依赖包,通常需要创建一个发布版的 Python 包。下面是一些简单的步骤来实现这一目标:
1.创建项目结构:
在你的项目目录下,确保有一个合适的项目结构,通常包括以下文件和文件夹:
项目代码文件(Python 源代码)
setup.py 文件:用于描述包的元数据和配置打包过程
README.md 文件:包含包的说明文档
其他必要文件或文件夹
2.编写 setup.py 文件:
setup.py 是用于描述 Python 包的构建和安装信息的脚本文件。在 setup.py 中,你需要指定包的名称、版本、作者、依赖项等信息。一个简单的 setup.py 可能如下所示:
from setuptools import setup
setup(
name='your_package_name',
version='1.0',
packages=['your_package'],
install_requires=[
'package1',
'package2',
],
)
3.构建包:
在命令行中进入项目目录,运行以下命令来构建包:
python setup.py sdist
4.发布包:
将生成的 .tar.gz 文件上传到 PyPI 或其他 Python 包索引网站,以便他人可以通过 pip 安装:
twine upload dist/*
5.安装包:
他人可以通过以下命令使用 pip 安装你的包:
pip install your_package_name
例子:
# -*- coding: utf-8 -*-
# @Time : 2024/2/19 16:22
# @Author : lint
try:
from setuptools import setup
except ImportError:
from distutils.core import setup
# 需要将那些包导入
packages = [包的路径,如"util_tool", "util_tool.log"]
# 第三方依赖
requires = [
]
setup(
name="util_tool", # 包名称
version="1.0.0", # 包版本
description="", # 包详细描述
long_description="", # 长描述,通常是readme,打包到PiPy需要
author="", # 作者名称
author_email="", # 作者邮箱
url="www.baidu.com", # 项目官网
packages=packages, # 项目需要的包
include_package_data=False, # 是否需要导入静态数据文件
python_requires=">=3.0, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*", # Python版本依赖
install_requires=requires, # 第三方库依赖
zip_safe=False, # 此项需要,否则卸载时报windows error
classifiers=[ # 程序的所属分类列表
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Natural Language :: English',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: Implementation :: CPython',
'Programming Language :: Python :: Implementation :: PyPy'
],
)