详细步骤 | 打包制作自己的 Python 模块包并上传到 Pip 源 PyPI

最新推荐文章于 2024-03-05 09:30:33 发布
最新推荐文章于 2024-03-05 09:30:33 发布
阅读量1.7k 收藏 11
点赞数 5
分类专栏： Python 文章标签： python pip 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40738764/article/details/134263322
版权

文章目录

前言

本文介绍如何打包一个简单的 Python 项目，以及如何将其上传到Python包索引平台(PyPI)，供他人使用 pip install xxx 指令安装。

一、准备构建包的文件

文件目录结构：

packaging_tutorial/
├── pyproject.toml
├── src/
│   └── example_package_YOUR_USERNAME_HERE/
│       ├── __init__.py
│       └── example.py
├── LICENSE 
├── MANIFEST.in
└── README.md

说明：packaging_tutorial 可以是任意的目录名，pyproject.toml 是打包配置文件，src 里面存放的就是你的程序代码，example_package_YOUR_USERNAME_HERE 需要改成你期望发布的模块包名（官方建议是在包名后面加上自己的用户名，防止和现有库名重复），LICENSE 是许可信息，MANIFEST.in 是非必需的，如果需要打包代码文件夹以外的文件要在这里面配置，README.md 就是 readme 文件，也是非必需。

1.1 pyproject.toml

pyproject.toml 里可以配置包名、项目依赖等信息：

[project]
name = "example_package_YOUR_USERNAME_HERE"
version = "0.0.1"
authors = [
  { name = "Example Author", email = "author@example.com" },
]
dependencies = []
description = "A small example package"
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
]

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project.urls]
"Homepage" = "https://github.com/pypa/sampleproject"
"Bug Tracker" = "https://github.com/pypa/sampleproject/issues"

其中，name 和前面的“目录结构”里的 example_package_YOUR_USERNAME_HERE 一致，该成你的模块包名。version 是待构建模块包的版本号。authors 是作者信息，可以添加多个作者。dependencies 可以添加项目依赖的第三方库的信息，在安装时会自动安装这些依赖库。description 是模块描述。readme 指定readme文件，较长的描述可以写在 readme 文件里。requires-python 是模块依赖的 Python 版本号。classifiers 指定 编程语言、许可证、操作系统的信息，基本就只用改 License，有严格的写法要求，具体可以查看：https://pypi.org/classifiers/。

build-system 选择构建后端，支持 Hatchling、setuptools、Flit、PDM

# Hatchling
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
# setuptools
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
# Flit
[build-system]
requires = ["flit_core>=3.4"]
build-backend = "flit_core.buildapi"
# PDM
[build-system]
requires = ["pdm-backend"]
build-backend = "pdm.backend"

project.urls 里可以添加一些链接，如bug反馈、文档等…

例如：

[project]
name = "bhsenti"
version = "0.0.1"
authors = [
    { name = "bhnw", email = "bhshare.cn@gmail.com" },
]
dependencies = ['transformers>=4.27.1', 'onnxruntime']
description = "基于三分类的中文情感分析"
readme = "README.md"
requires-python = ">=3"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
    "Operating System :: OS Independent",
]
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
[project.urls]
"Homepage" = "https://github.com/yaokui2018"
"Bug Tracker" = "https://github.com/yaokui2018/bhsenti/issues"

1.2 MANIFEST.in

可以在里面配置需要 添加 或者 排除 的Python代码以外的文件。格式示例如下：

# 包含所有文件和目录
include *

# 排除不需要的文件和目录
exclude some_directory/
exclude *.txt

1.3 LICENSE

LICENSE 用来告诉安装软件包的用户，他们可以根据条款使用你的软件包。请参阅https://choosealicense.com/。选择许可后，复制许可文本到 LICENSE 文件。

  • MIT License
    简短而直接，允许他人对你的项目几乎做任何事情，包括制作和分发闭源版本。
    对共享改进非常友好，因为它允许他人自由地使用、修改和分发你的代码。
  • GNU GPLv3
    允许他人几乎做任何事情，但不允许分发闭源版本，要求任何基于你的项目构建的派生作品必须使用相同的许可证发布。
    与 MIT 许可证相比更加强调对开源共享的支持，鼓励共享改进并保证了代码的开放性。
  • Apache License 2.0
    允许他人几乎做任何事情，包括制作、使用和分发闭源版本，但在使用你的专利时提供了一些额外的保护。
    要求在派生作品中包含原始许可和免责声明。
  • …

例如：选择 MIT License 

Copyright (c) 2018 The Python Packaging Authority

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

1.4 README.md

就是 readme 文件了…没啥好解释的

# Example Package

This is a simple example package. You can use
[GitHub-flavored Markdown](https://guides.github.com/features/mastering-markdown/)
to write your content.

二、构建包

2.1 安装 build 库

pip install --upgrade build

2.2 打包构建

终端里切换到 pyproject.toml 文件所在目录，运行下面的指令：

python -m build

在这里插入图片描述
等待构建完成，提示 Successfully built 的提示，当前目录即会多出一个 dist 文件夹，里面有两个文件，即是打包好的文件。

dist/
├── example_package_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
└── example_package_YOUR_USERNAME_HERE-0.0.1.tar.gz

tar.gz 文件是一个源发行版，而 .whl 文件是构建发行版。较新的pip版本会优先安装构建后的发行版，但如果需要的话会回退到源代码发行版。你应该始终上传源代码发行版，并为你的项目兼容的平台提供构建后的发行版。在这种情况下，我们的示例包在任何平台上都与Python兼容，因此只需要一个构建的发行版。

如果本地使用，就可以直接 pip install xxxxxx.whl 安装模块包进行测试了。

三、上传模块包到PyPI

3.1 注册 PyPI 账号

在 PyPI 上注册一个帐号：https://pypi.org/account/register/。
按提示完成电子邮件地址验证、以及一些安全设置。

3.2 创建 API Token

访问：https://pypi.org/manage/account/token/，按下图步骤创建 PyPI API token.。

在这里插入图片描述
在这里插入图片描述

3.3 创建 .pypirc 文件

在系统 HOME 目录创建 .pypirc 配置文件:

  • Linux : ~/.pypirc
  • Windows： C:\Users\用户名\.pypirc

文件内容如下：

[distutils]
index-servers=pypi

[pypi]
repository = https://upload.pypi.org/legacy/
username = __token__
password = <Token>

其中，<Token> 改成上一步创建的 token（以pypi-开头的）。如果觉得不安全也可以 username 和 password 两行删除，在后面的上传过程中会提示让手动输入。

3.4 安装 twine 库

pip install --upgrade twine

3.5 上传模块包

终端里运行下面指令上传 dist 目录的模块包到 PyPI 平台。

twine upload dist/*

在这里插入图片描述

访问下面的链接就可以… 剩下的应该都懂了 over

在这里插入图片描述

附录：
本文构建的模块包源码：https://github.com/yaokui2018/bhsenti
官方详细教程：https://packaging.python.org/en/latest/tutorials/packaging-projects/

薄荷你玩_
关注
  • 5
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
python 制作python包,封装成可用模块教程
12-17
首先编写py程序: printtest.py def test(): print(‘print test’) 将以上.py文件做成python模块，需要在相同目录下创建setup.py文件，setup.py中输入配置信息: from setuptools import setup setup(name='printtest', version='1.0', py_modules=['printtest'], ) 打开终端，定位到该文件夹下，输入： python setup.py sdist 此时在目录中生成dist文件夹，文件夹中有testpg-1.0.tar.gz文
上传python包到Pypi
05-01
NULL 博文链接：https://youcou12.iteye.com/blog/2384563
Python 包制作
weixin_30906671的博客
04-16 95
Python 包制作 官方文档 Python 包目录 /package_parent_folder /package /__init__.py 在__init__.py文件内添加name = package，其中package指的是包名 在package_parent_folder下添加包文件setup.py、LICENSE、README.md文件。 LICENSE: 包许可说明 ...
python打包两种方式：setup.py、pyproject.toml；entry_points、project.scripts 可执行的命令行
最新发布
weixin_42357472的博客
03-05 660
参考： https://blog.csdn.net/qq_38844437/article/details/126628564 https://click.palletsprojects.com/en/7.x/setuptools/#setuptools-integration学习写法：https://github.com/myshell-ai/MeloTTS/blob/main/setup.pyyourscript.py: setup.py: pyproject.toml 参考：https://blog.
上传python包到PyPI
weixin_30270889的博客
07-08 133
一、前言 由于项目需要将API响应的XML内容解析成python对象，写了一个简单的xml转python的库，因为功能简单，细节处理也不好，文档也没有，没想也不好意思上传到pypi。 后来由于多个不同的独立的服务都需要这个转换功能，如果每个服务都把这个库放置于各自的目录下，维护起来很麻烦，才想到完善这个库，上传到PyPI，通过pip来统一管理。 二、创建账号 在PyPI正式站点和PyPI测...
python 构建一个包
weixin_42591413的博客
01-25 220
要构建一个 Python 包，需要遵循以下步骤: 创建一个文件夹，命名为你想要的包名。 在该文件夹中创建一个名为 "init.py" 的文件，用于标识该文件夹为一个 Python 包。 在该文件夹中创建你的 Python 模块，每个模块对应一个 .py 文件。 在该文件夹中创建一个名为 "setup.py" 的文件，用于配置包的相关信息。 使用命令 "python setup.py sd...
Python(三十三)制作python包
wzj_110的博客
03-29 209
官方指导 一 基本流程 二 项目结构 说明： '__init__.py'文件主要是 'import' 的时候'调用的文件',必须'存在',否则'其他人'导入模块不成功 ① LICENSE MIT模板 ②基本文件 ② setup.py 三 打包 ① 安装打包工具 ② 验证setup.py的正确性 ③进行打包 #python setup.py build # 编译 #python setup.py ...
python自制包并用pip免提交到pypi仅安装到本机【推荐】
09-19
主要介绍了python自制包并用pip免提交到pypi仅安装到本机,本文分步骤给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友可以参考下
Python pip替换为阿里源的方法步骤
01-01
由于 python 自带的源下载速度非常慢，特别是安装一些库的时候，甚至有时会失败。 pip国内的一些镜像   阿里云 http://mirrors.aliyun.com/pypi/simple/    中国科技大学 ...
Python基于pip实现离线打包过程详解
09-16
主要介绍了Python基于pip实现离线打包过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
打包发布Python模块的方法详解
12-25
昨天把自己的VASP文件处理库进行了打包并上传到PyPI，现在可以直接通过pip和easy_install来安装VASPy啦（同时欢迎使用VASP做计算化学的童鞋们加星和参与进来）， VASPy的GotHub地址：...
制作python模块安装包(转)
weixin_30455365的博客
12-04 104
python的第三方模块越来越丰富，涉及的领域也非常广，如科学计算、图片处理、web应用、GUI开发等。当然也可以将自己写的模块进行打包或发布。一简单的方法是将你的类包直接copy到python的lib目录，但此方式不便于管理与维护，存在多个python版本时会非常混乱。现介绍如何编写setup.py来对一个简单的python模块进行打包。一、编写模块进入项目目录#cd /home/pysetu...
python 制作自定义包并安装到系统目录
weixin_33709609的博客
11-30 295
1.python 制作自定义包并安装到系统目录 1.1 背景 下载的数据过多，对同一份html,可能不同的任务都对它进行解析，每次结构一遍，每个任务下的解析都要重新编写，重复量过大，写一份解析，对外提供接口，即将解析自定义分装成库，使用的地方安装即可，之后只要维护这个库的更新即可。 1.2 包 1.2.1制作并安装包 在包baidubaikeMaster同级的目录中创建setup.py...
python打包上传pypi
呀一1不小心的博客
05-20 337
主要流程： 1.pypi注册登录并创建token（https://pypi.org/manage/account/token/）， 2. 本地创建~/.pypirc文件并添加 [pypi] username = __token__ password = （上步创建的token） 3. 安装twine pipinstalltwine 4.编写setup.py可参考https://packaging.python.org/tutor...
怎么制作自己的python库/包？
乐趣是人为构建的，构建是一种莫大的乐趣。
03-03 3024
1.官方文档 2.步骤： 首先需要按照官网的要求组织这样的文件目录： project_name/ ├── LICENSE ├── pyproject.toml ├── README.md ├── setup.cfg ├── src/ │ └── package_name/ │ ├── __init__.py │ └── your_func_and_class_here.py └── tests/ __init__.py文件为空,其他的文件按照官网所示和自己需求制作。pack
教你在几分钟内构建一个Python包
09-16 651
前言 构建包的过程有些复杂，但从长远来看是值得的，尤其是可以创建属于自己的Python包。本文的目的是通过对构建一个新发行包的案例研究，让您了解需要构建什么以及如何构建python包的基础知识。 开始 首先，您肯定需要设置一个或多个内容，以便了解如何构建python包。因此，需要的东西的如下: IDE (Vs Code) Python 3 构建Python包 本文中构建的标称为b_dist。b_dist是一个分布包，它有Gaussian, Binomial, e.t.c等类。但首先，使用下
上传包到pypi
chupiti2317的博客
09-11 132
修改pypi配置文件 vi ~/.pypirc [distutils] index-servers=pypi [pypi] repository = https://upload.pypi.org/legacy/ username = wzyuliyang password=密...
上传python包到PyPi（含本人实列）
GodGump的博客
05-06 490
最近搞机器学习，很多东西都在重复做。重复的代码可以使用函数，重复的调用就要写py文件了。每次导入py又很麻烦，怎么才能省事呢？于是我想到了pip，言归正传，下面分布介绍pip。 注册Pypi账号 点我注册 创建项目工程或者独立py文件 1.文件不允许在ifmain以外的地方出现print函数以及控制运行的函数数量 如果非要这么做，请使用以下代码： if __name__ == "__main__": your example code goes here 2.项目结构应该为如下标准（名字仅供参考）
python创建自己的包_python 创建自己的包
weixin_42305634的博客
02-10 585
创建步骤：创建一个文件夹：mymath,在该文件夹下创建三个python 文件，分别为：__init__.py getMax.py getMin.py__init__.py: 这个文件必须以__init__命名，包管理器会自动寻找这个文件__author__ = 'bloodchilde'__all__=["getMax","getMin"]getMax.py:__author__...
python3安装setuptools步骤_Python打包分发工具setuptools使用教程
06-11
好的，我知道了。关于Python打包分发工具setuptools的安装和使用，具体步骤如下： 1. 首先，确保你已经安装了Python3。如果没有安装，可以去Python官网下载并安装。 2. 接着，在命令行中输入以下命令来安装setuptools： ``` pip3 install setuptools ``` 3. 安装完成后，你可以使用以下命令来验证setuptools是否安装成功： ``` python3 -m easy_install --version ``` 如果输出了setuptools的版本号，说明安装成功。 4. 接下来，你可以使用setuptools来打包你的Python项目。在你的项目根目录下创建一个名为`setup.py`的文件，内容如下： ``` from setuptools import setup, find_packages setup( name='your-project-name', version='0.1', packages=find_packages(), install_requires=[ 'dependency1', 'dependency2', # ... 其他依赖项 ], entry_points={ 'console_scripts': [ 'your-script-name=your_package_name.module_name:main' ] } ) ``` 其中，`name`是你的项目名称，`version`是你的项目版本号，`packages`是你的项目中包含的所有Python模块，`install_requires`是你的项目依赖的所有Python包，`entry_points`是你的项目可执行文件的入口。 5. 编写完`setup.py`文件后，你可以使用以下命令来构建一个源码分发包： ``` python3 setup.py sdist ``` 6. 构建完成后，你可以使用以下命令来安装你的项目： ``` pip3 install your-project-name-0.1.tar.gz ``` 7. 如果你的项目需要发布到PyPI等Python包管理平台上，可以使用以下命令来上传你的项目： ``` python3 setup.py sdist upload ``` 以上就是使用setuptools进行Python打包分发的基本步骤。希望对你有所帮助。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

薄荷你玩_

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值