048.Python包和模块_发布包和模块

2024-01-09 13:19:14

无奋斗不青春

我 的 个 人 主 页：👉👉 失心疯的个人主页 👈👈
入 门 教 程 推 荐 ：👉👉 Python零基础入门教程合集 👈👈
虚 拟 环 境 搭 建 ：👉👉 Python项目虚拟环境(超详细讲解) 👈👈
PyQt5 系 列 教 程：👉👉 Python GUI(PyQt5)文章合集 👈👈
Oracle数据库教程：👉👉 Oracle数据库文章合集 👈👈
优 质 资 源 下 载 ：👉👉 资源下载合集 👈👈

分隔线

发布包和模块

发布包和模块

文档地址

  • 发布包和模块的详细说明
  • https://python-packaging.readthedocs.io/en/latest/minimal.html

账号操作

  • 注册账号：https://pypi.org/account/register/
  • 账号：FengZi2023
  • 邮箱：860205500@qq.com

环境准备

  • setuptools安装
    • 将所写的代码打包成源码和.egg格式
  • wheel安装
    • 将所写的代码打包成.whl格式
    pip install wheel

# 安装到指定版本python环境
python -m pip install wheel
  • twine安装
    • 快速发布本地已经打包成不同格式的包和模块到pypi平台
    pip install twine
  • pip
    • 测试上传的包和模块

发布前准备

创建一个项目
命名规则
  • 全部小写
  • 多个单词以中划线"-“作为分割，不要使用下划线”_",pip安装队下划线支持部是很好
  • 不能和PyPi平台上已有的包名称重复
项目解析

  • 项目结构

    项目名称
    包名称
        __init__.py
        模块
    模块
    setup.py
    README.rst
    LICENSE.txt
    MANIFEST.in
    

# setup.py 项目信息的配置文件
# 这里面最重要的就是执行一个setup函数，通过这个函数来指明信息
from distutils.core import setup
setup(形参1=实参1, 形参2=实参2)

# 建议使用
from setuptools import setup
setup(形参1=实参1, 形参2=实参2)

  • 示例

  • 在这里插入图片描述

  • fzlibone.py文件代码

    def run():
    print('fzlibone----run')

  • __init__.py文件代码

    # 使用户通过import fztestlib 导入包，能调用fzlibone.py内部资源
# import导入包的时候会自动调用__init__.py文件代码

from . import fzlibone

  • Tool.py文件代码

    def test():
    print('Tool----test')

  • setup.py文件代码

    # from distutils.core import setup
from setuptools import setup
setup(name="fztestlib", version="1.0.0",description="this is a niubi lib",
      packages=["fztestlib"], py_modules=["Tool"], author='FZ', author_email="860205500@qq.com",
      long_description="this is a hen long hen long lib", url="https://www.baidu.com")
    • setup.py参数说明
    • 详细文档说明：https://packaging.python.org/en/latest/tutorials/packaging-projects/
    # -----必填选项-----
# name                  # 包名称（如：name = "fztestlib"）
# version               # 包版本（如：version="1.0.0"）
# description           # 描述信息（如：description="this is a very niubi lib"）
# packages              # 需要处理的包列表（如：packages=["fztestlib"]）
                        # 这里是告诉打包工具要将哪些子包打包到整个大包里面

# -----非必填选项-----
# py_modules            # 需要处理的单文件模块列表（如：py_modules=["Tool"]）
# author                # 作者（如：author="FZ"）
# author_email          # 作者邮箱（author_email="860205500@qq.com"）
# long_description      # 长描述，会显示在PyPi平台的项目介绍中
                        # 如：long_description="这里的字符串是可以从readme.rst文件中读取进来的"
# install_requires      # 依赖的其他包（如：install_requires=["requests>2.29"]）
# python_requires       # Python版本限制（如：python_requires=">=3"）
# url                   # 项目主页地址（如：url="https://..."）
# license               # 协议（如：license="MIT"）
.
.
.

  • 文件打包

    1、打开命令行工具(cmd)，进入到项目目录
2、输入打包命令：python setup.py sdist
# 个人理解：使用python执行setup.py文件，创建一个源码编译包
# 这里打包出来的是源码文件压缩包，可以直接上传到PyPi平台
# 最终打包出来的包名称由setup.py中的name和version通过一个“-”拼接而成
# 打包时包含的文件有setup.py文件中的packages和py_modules两个参数设定（包 和 单文件模块）
    • 在这里插入图片描述

  • 其他可选文件说明

  • README.rst 文件

    • 具体语法文档说明：https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html
    #     rst：reStructuredText，重新构建的文本
# 作   用：
    # 可以使用特定的字符，来描述文本的格式
    # PyPi平台能够自动识别long_description字段中缩写的这种格式的字符串
    # 如果全部写到setup.py文件的setup函数的参数中，会比较混乱
    # 一般会将内容单独写到一个README.rst文件中
    # 然后在setup.py文件中读取这个内容，并赋值给long_description参数即可
# 语法格式
    # 具体语法文档说明：https://zh-sphinx-doc.readthedocs.io/en/latest/contents.html
    
    # 建议使用PyCharm编辑，内部安装了一个支持.rst文件的插件，能自动识别rst语法格式
    # 插件：settings —— plugins —— ReStructuredText
    # 如果没有，则手动安装一下
# 语法检测（截止当前学习的时候202312，PyCharm会直接显示.rst文件效果）
    # 检测rst文件中的内容，在PyPi平台上是否能正常显示
    # 我们正常是参照sphinx解析器，但是Pypi平台对于rst的解析器并不是sphinx
    # 所以，会导致部分语法有一些差异
    # 解决方案：通过readme_renderer库从本地对long_description进行验证
    # 安装库：pip install readme_renderer
    # 执行命令：python setup.py check -r -s
    # -r：检测文件是否符合ReStructuredText语法
    # -s：如果不符合，则退出
    # 如果符合则输出：running check
    • PyCharm中README.rst文件中文显示乱码问题解决

      • 在这里插入图片描述

      • 在这里插入图片描述

      • Help —— Edit Custom VM Options… —— 添加一行

      -Dfile.encoding=UTF-8
      • 重启PyCharm

  • LICEBSE.txt 文件

    • 开源协议获取地址：https://choosealicense.com
    # 作用：声明库的一些使用责任等
# 比如：所有权归属；别人是否可以对代码进行任何操作；是否可以用于其他商业用途等
# 开源协议获取地址：https://choosealicense.com
# 可以到开源协议网址内复制协议内容粘贴到LICEBSE.txt文件中

  • MANIFEST.in 文件

    # 作用：
    # 当我们打包一个项目的时候，并非所有的文件都会被默认打包在目标包中
    # 打包工具最终会把所有已经打包的文件生成一个MANIFEST文件的列表
    # 我们就可以通过MANIFEST.in文件告诉打包工具，让其新增一些指定文件
# 具体官方文档
    
# 语法格式
    # include 文件名全名(含后缀)                    # 添加导入指定文件
    # include *.txt                                 # 添加导入指定类型的文件
    # recursive-include examples *.txt *.py         # 递归查询指定文件夹examples内所有子文件夹中指定类型的文件
    # prune examples/sample?/build                  # 屏蔽指定文件夹build内的所有文件
编译生成发布包
  • 编译语法
    # cmd命令行工具，进入到setup.py所在目录

# 查看所有命令
python setup.py --help-commands

# 生成源码压缩包
python setup.py sdist
# 包含setup.py、模块源文件、数据文件等，可以用在任何平台上重新编译所有内容
# --formats = 压缩格式1, 压缩格式2(zip、tar、gztar、bztar、xztar、ztar)

# 生成二进制发行包
python setup.py bdist
# 不包含setup.py文件，是某个特定平台和Python版本的一个存档

# 生成一个编译后的egg格式发行包
python setup.py bdist_egg
# python环境必须安装setuptools库

# 生成一个编译后的whl格式发行包
python setup.py bdist_wheel
# python环境必须安装wheel库

# 生成一个windows系统可执行安装的发行包
python setup.py bdist_wininst
    • 在这里插入图片描述
安装编译的发布包
  • 安装带setup.py源码压缩包
    • 方式一
      1、解压压缩包
2、cmd进入到setup.py文件所在目录
3、执行python setup.py install
    • 方式二
      pip install 压缩包
    • 方式三
      easy_install 压缩包
  • 安装二进制发行包
    • 解压后直接拷贝到指定目录
  • 通过windows下的安装文件安装
    • 直接双击exe文件进行安装
  • 安装.egg格式发行包
    easy_install xxx.egg
  • 安装.whl格式发行包
    easy_install xxx.whl

pip install xxx.whl

发布过程

  • 注意：Python环境需要安装twine库
  • 上传带setup.py文件的源码压缩包
    twine upload 源码压缩包

# 这里上传的时候需要输入前面注册的账号和密码
# 现在上传必须启用双因素身份验证
WARNING  Error during upload. Retry with the --verbose option for more details.
ERROR    HTTPError: 403 Forbidden from https://upload.pypi.org/legacy/
         You must enable two factor authentication to upload

发布后使用

  • 详见上面包安装操作

文章来源:https://blog.csdn.net/weixin_50296259/article/details/135477145
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。