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

2024-01-09 13:52
文章标签 python 模块 发布 048

本文主要是介绍048.Python包和模块_发布包和模块,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

无奋斗不青春

我 的 个 人 主 页:👉👉 失心疯的个人主页 👈👈
入 门 教 程 推 荐 :👉👉 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.pyREADME.rstLICENSE.txtMANIFEST.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.whlpip 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
    

发布后使用

  • 详见上面包安装操作

这篇关于048.Python包和模块_发布包和模块的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/587335

相关文章

使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)

《使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)》PPT是一种高效的信息展示工具,广泛应用于教育、商务和设计等多个领域,PPT文档中常常包含丰富的图片内容,这些图片不仅提升了... 目录一、引言二、环境与工具三、python 提取PPT背景图片3.1 提取幻灯片背景图片3.2 提取

Python实现图片分割的多种方法总结

《Python实现图片分割的多种方法总结》图片分割是图像处理中的一个重要任务,它的目标是将图像划分为多个区域或者对象,本文为大家整理了一些常用的分割方法,大家可以根据需求自行选择... 目录1. 基于传统图像处理的分割方法(1) 使用固定阈值分割图片(2) 自适应阈值分割(3) 使用图像边缘检测分割(4)

一文带你搞懂Python中__init__.py到底是什么

《一文带你搞懂Python中__init__.py到底是什么》朋友们,今天我们来聊聊Python里一个低调却至关重要的文件——__init__.py,有些人可能听说过它是“包的标志”,也有人觉得它“没... 目录先搞懂 python 模块(module)Python 包(package)是啥?那么 __in

使用Python实现图像LBP特征提取的操作方法

《使用Python实现图像LBP特征提取的操作方法》LBP特征叫做局部二值模式,常用于纹理特征提取,并在纹理分类中具有较强的区分能力,本文给大家介绍了如何使用Python实现图像LBP特征提取的操作方... 目录一、LBP特征介绍二、LBP特征描述三、一些改进版本的LBP1.圆形LBP算子2.旋转不变的LB

Python中__init__方法使用的深度解析

《Python中__init__方法使用的深度解析》在Python的面向对象编程(OOP)体系中,__init__方法如同建造房屋时的奠基仪式——它定义了对象诞生时的初始状态,下面我们就来深入了解下_... 目录一、__init__的基因图谱二、初始化过程的魔法时刻继承链中的初始化顺序self参数的奥秘默认

Python实现特殊字符判断并去掉非字母和数字的特殊字符

《Python实现特殊字符判断并去掉非字母和数字的特殊字符》在Python中,可以通过多种方法来判断字符串中是否包含非字母、数字的特殊字符,并将这些特殊字符去掉,本文为大家整理了一些常用的,希望对大家... 目录1. 使用正则表达式判断字符串中是否包含特殊字符去掉字符串中的特殊字符2. 使用 str.isa

python中各种常见文件的读写操作与类型转换详细指南

《python中各种常见文件的读写操作与类型转换详细指南》这篇文章主要为大家详细介绍了python中各种常见文件(txt,xls,csv,sql,二进制文件)的读写操作与类型转换,感兴趣的小伙伴可以跟... 目录1.文件txt读写标准用法1.1写入文件1.2读取文件2. 二进制文件读取3. 大文件读取3.1

使用Python实现一个优雅的异步定时器

《使用Python实现一个优雅的异步定时器》在Python中实现定时器功能是一个常见需求,尤其是在需要周期性执行任务的场景下,本文给大家介绍了基于asyncio和threading模块,可扩展的异步定... 目录需求背景代码1. 单例事件循环的实现2. 事件循环的运行与关闭3. 定时器核心逻辑4. 启动与停

基于Python实现读取嵌套压缩包下文件的方法

《基于Python实现读取嵌套压缩包下文件的方法》工作中遇到的问题,需要用Python实现嵌套压缩包下文件读取,本文给大家介绍了详细的解决方法,并有相关的代码示例供大家参考,需要的朋友可以参考下... 目录思路完整代码代码优化思路打开外层zip压缩包并遍历文件:使用with zipfile.ZipFil

Python处理函数调用超时的四种方法

《Python处理函数调用超时的四种方法》在实际开发过程中,我们可能会遇到一些场景,需要对函数的执行时间进行限制,例如,当一个函数执行时间过长时,可能会导致程序卡顿、资源占用过高,因此,在某些情况下,... 目录前言func-timeout1. 安装 func-timeout2. 基本用法自定义进程subp