用Python将库打包发布到pypi


Posted in Python onApril 13, 2021

如果需要将自己写好的python打包,并发布到pypi,这样其他人就可以直接通过pip install来安装对应的包,可以参考如下教程

1. 注册pypi账号并创建token

首先访问https://pypi.org/ 并注册账号
然后跳转到账号设置

用Python将库打包发布到pypi

然后选择API token->Add API token

用Python将库打包发布到pypi

输入token name并在Scope中选择Entire account(第一次需要选择Entire account)

用Python将库打包发布到pypi

然后在本地,修改.pypirc文件
输入的内容为:

[pypi]
username = __token__
password = {token}

只需要修改{token}为自己的token即可

2. 编写setup.py和setup.cfg

setup.cfg的内容为

[metadata]
license_files = LICENSE.txt

LICENSE.txt是license文件,需要自行编写
setup.py在根目录下,一个示例为

from setuptools import setup
import compileall
from os import path
# 读取readme文件,这样可以直接显示在主页上
this_directory = path.abspath(path.dirname(__file__))
with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
    long_description = f.read()

compileall.compile_dir("src")

setup(
    name='my-python',
    version='1.0.2',
    packages=['src',
              'src.main',
              'src.main.config'],
    url='https://github.com/hTangle',
    license='Apache 2.0',
    author='hTangle',
    author_email='',
    description='',
    keywords='',
    python_requires='>=3.4, <4',
    long_description=long_description,
    long_description_content_type='text/markdown',
    install_requires=['requests']
)

具体的字段含义如下:

name: 包名

version: 版本号,支持如下形式

1.2.0.dev1  # Development release
1.2.0a1     # Alpha Release
1.2.0b1     # Beta Release
1.2.0rc1    # Release Candidate
1.2.0       # Final Release
1.2.0.post1 # Post Release
15.10       # Date based release
23          # Serial release

description: 包描述,会放在如下图所示的位置处

用Python将库打包发布到pypi

url: 包的链接,可以使用github链接,pypi会自动获取到仓库的信息,示例如下:


用Python将库打包发布到pypi

author: 作者

license: 许可证

classifiers: 分类,示例如下:

classifiers=[
    # How mature is this project? Common values are
    #   3 - Alpha
    #   4 - Beta
    #   5 - Production/Stable
    'Development Status :: 3 - Alpha',

    # Indicate who your project is intended for
    'Intended Audience :: Developers',
    'Topic :: Software Development :: Build Tools',

    # Pick your license as you wish (should match "license" above)
    'License :: OSI Approved :: MIT License',

    # Specify the Python versions you support here. In particular, ensure
    # that you indicate whether you support Python 2, Python 3 or both.
    'Programming Language :: Python :: 2',
    'Programming Language :: Python :: 2.7',
    'Programming Language :: Python :: 3',
    'Programming Language :: Python :: 3.6',
    'Programming Language :: Python :: 3.7',
    'Programming Language :: Python :: 3.8',
    'Programming Language :: Python :: 3.9',
],

keywords: 关键字,和论文的关键字类似

project_urls: 一些项目的其他链接,示例如下

project_urls={
    'Documentation': 'https://packaging.python.org/tutorials/distributing-packages/',
    'Funding': 'https://donate.pypi.org',
    'Say Thanks!': 'http://saythanks.io/to/example',
    'Source': 'https://github.com/pypa/sampleproject/',
    'Tracker': 'https://github.com/pypa/sampleproject/issues',
},

packages: 需要打包的目录,需要以根目录为起点,可以使用

find_packages自动查找包,注意不要漏写

install_requires: 包依赖的其他包

python_requires: python的版本需求

package_data: 需要的额外的文件,例如包强依赖一个本地文件,可以使用如下

package_data={
    'sample': ['package_data.dat'],
},

3. 打包

打包命令为

python setup.py cmd

cmd可以取值为

bdist_wheel : create a wheel distribution

bdist_egg : create an “egg” distribution

sdist : create a source distribution (tarball, zip file, etc.)

bdist : create a built (binary) distribution

bdist_dumb : create a “dumb” built distribution

bdist_rpm : create an RPM distribution

bdist_wininst : create an executable installer for MS Windows

打包为tar.gz

python setup.py sdist

打包好的文件再dist目录下

4. 上传

可以首先使用twine对包进行检查

twine check dist/*

输出如下

用Python将库打包发布到pypi

再运行上传命令

twine upload dist/*

到此这篇关于用Python将库打包发布到pypi的文章就介绍到这了,更多相关python打包到pypi内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
Python中title()方法的使用简介
May 20 Python
bpython 功能强大的Python shell
Feb 16 Python
Python的SimpleHTTPServer模块用处及使用方法简介
Jan 22 Python
Python闭包之返回函数的函数用法示例
Jan 27 Python
Python使用numpy产生正态分布随机数的向量或矩阵操作示例
Aug 22 Python
python函数修饰符@的使用方法解析
Sep 02 Python
Python 之 Json序列化嵌套类方式
Feb 27 Python
python GUI库图形界面开发之PyQt5信号与槽基础使用方法与实例
Mar 06 Python
PyTorch中的C++扩展实现
Apr 02 Python
浅谈matplotlib默认字体设置探索
Feb 03 Python
python 中的jieba分词库
Nov 23 Python
使用Python拟合函数曲线
Apr 14 Python
python xlwt模块的使用解析
python 爬取豆瓣网页的示例
简述python四种分词工具,盘点哪个更好用?
Apr 13 #Python
python自动化调用百度api解决验证码
利用Python网络爬虫爬取各大音乐评论的代码
用Python制作灯光秀短视频的思路详解
python实现socket简单通信的示例代码
You might like
php安全之直接用$获取值而不$_GET 字符转义
2012/06/03 PHP
ThinkPHP之foreach标签使用概述
2014/06/30 PHP
Prototype使用指南之selector.js说明
2008/10/26 Javascript
javascript 鼠标拖动图标技术
2010/02/07 Javascript
Google AJAX 搜索 API实现代码
2010/11/17 Javascript
利用javascript解决图片缩放及其优化的代码
2012/05/23 Javascript
理解JAVASCRIPT中hasOwnProperty()的作用
2013/06/05 Javascript
18个非常棒的jQuery代码片段
2015/11/02 Javascript
jquery.validate[.unobtrusive]和Bootstrap实现tooltip错误提示问题分析
2016/10/30 Javascript
Express与NodeJs创建服务器的两种方法
2017/02/06 NodeJs
JS和Canvas实现图片的预览压缩和上传功能
2018/03/30 Javascript
JavaScript实现简单的文本逐字打印效果示例
2018/04/12 Javascript
JavaScript中关于base64的一些事
2019/05/06 Javascript
atom-design(Vue.js移动端组件库)手势组件使用教程
2019/05/16 Javascript
Element Collapse 折叠面板的使用方法
2020/07/26 Javascript
JavaScript数组常用的增删改查与其他属性详解
2020/10/13 Javascript
[02:57]DOTA2亚洲邀请赛小组赛第四日 赛事回顾
2015/02/02 DOTA
[46:20]TFT vs Secret Supermajor小组赛C组 BO3 第二场 6.3
2018/06/04 DOTA
python脚本实现统计日志文件中的ip访问次数代码分享
2014/08/06 Python
Python3.0与2.X版本的区别实例分析
2014/08/25 Python
简单理解Python中基于生成器的状态机
2015/04/13 Python
Python实现批量转换文件编码的方法
2015/07/28 Python
Django小白教程之Django用户注册与登录
2016/04/22 Python
python将logging模块封装成单独模块并实现动态切换Level方式
2020/05/12 Python
numpy中生成随机数的几种常用函数(小结)
2020/08/18 Python
Python threading模块condition原理及运行流程详解
2020/10/05 Python
HTML5 placeholder(空白提示)属性介绍
2013/08/07 HTML / CSS
JavaScript获取当前url根目录(路径)
2014/02/19 面试题
函授自我鉴定
2013/11/06 职场文书
毕业研究生的自我鉴定
2013/11/30 职场文书
环保建议书
2014/03/12 职场文书
座谈会主持词
2014/03/20 职场文书
公司庆典欢迎词
2015/01/26 职场文书
五四青年节比赛演讲稿
2015/03/18 职场文书
考试没考好检讨书
2015/05/06 职场文书
weblogic服务建立数据源连接测试更新mysql驱动包的问题及解决方法
2022/01/22 MySQL