如何发布一个Python命令行工具

2023-02-22 13:16:02Python012

如何发布一个Python命令行工具,第1张

本文的目的也是非常简单:

写一个Python命令行工具,并且发布到PIP上面.并且在这个过程中给出我自己的一些思考.

如何分解这个发布任务?

只需要进行如下的两个步骤便可以:

1.写好一个Python命令行工具.

2.发布它.

当然,这样不够细致.再细分一下.

1.写好一个Python命令行工具

1.1.命令行的特点,以及Python的如何编写命令行

1.2.如何组织代码结构.

2.发布

2.1.注册pypi账户

2.2.注册在账户下面注册Python包

2.3.上传打包好的Python命令行工具.

3.完善代码

1.写好一个Python命令行工具

写好一个命令行工具首先要知道命令行工具是什么?

在我看来,命令行工具就是一种完成某种类型的任务的终端程序.

也就是基本上没有什么用户界面的程序.

由于基本上没有什么用户界面,所以导致单个命令行的交互能力及其低下.但这种低下的交互性对于一些固定工作而言,简直就是最灵活的工具.只需要输入一些命令便可以完成某种类型的工作.实在是方便的很.

所以,某种程度上,终端程序低交互的缺点反而成了优点.

1.1.Python的如何编写一个简单的命令行

对于Python和命令行交互,我们很容易想出一个比较方便的方案.

sys.argv就是这样的嘛!

我们很容易这样写代码.

python testargv.py thisisaargv1

甚至我们也可以这样写命令行,

python testargv.py thisisaargv1 -d -f 0

那么,这样写的后果就是,不方便解析出(不是不能,是不方便) -d -f 0 以及 thisisaargv1.

不信的话,你解析一个下面场景的命令行试试,

# 用户可能这样输入

danmu.fm -q 1 -v 2

# 当然,肯定还有漏写啦,等等,你得需要转类型,增加各种blablabla的描述吧,添加默认的参数值吧.

于是Python就提供了一个非常好用的模块可以使用.叫做argparse.

上面的描述就变成了这个样子

Python

import argparse

APP_DESC="""

这就是描述

"""

print(APP_DESC)

if len(sys.argv) == 1:

sys.argv.append('--help')

parser = argparse.ArgumentParser()

parser.add_argument('-q','--quality',type=int,default=0,help="download video quality : 1 for the standard-definition3 for the super-definition")

parser.add_argument('-v','--verbose', default=0,help="print more debuging information")

parser.add_argument('-s','--store',help="保存流媒体文件到指定位置")

parser.add_argument('-c','--config',default=0,help="读取~/.danmu.fm配置,请~/.danmu.fm指定数据库")

parser.add_argument('url',metavar='URL',nargs='+', help="zhubo page URL (*/)")

args = parser.parse_args()

# 获取对应参数只需要args.quality,args.url之类.

url = (args.url)[0]

print(url)

#其他执行逻辑

保存为danmu.py

这样就可以执行命令

python danmu.py -q 1 -v 2

通过args就可以获取参数,然后进行终端程序的参数初始化.

可是这和我们的要求还是不同嘛,我们不想多写Python XXX,我们想直接XXX.就像这样.

danmu.fm -q 1 -v 2

不急,下面就是了.

1.2.如何组织代码结构.

于是,现在就要开始组织代码结构了.

我们在最终的代码目录大概是这样的.

danmu.fm

├── README.md

├── danmufm

│ ├── __init__.py

│ ├── client

│ │ ├── __init__.py

│ │ ├── __init__.pyc

│ │ ├── douyu_client.py

│ │ └── douyu_danmu_client.py

│ ├── danmu.py

│ ├── misc

│ │ ├── __init__.py

│ │ ├── color_printer.py

│ │ ├── downloaders.py

│ │ └── player.py

│ └── model

│ ├── __init__.py

│ └── douyu_msg.py

├── docs

├── setup.cfg

├── setup.py

├── sh.py

└── tests

这就是我上次写的danmu.fm的代码目录.

聪明的你这时候你注意到了:

主要的程序不是放在根目录下面,而是放在第二目录danmufm下面.

2.setup.cfg 是什么鬼东西

3.setup.py 是什么鬼东西

对于上面几点,我们分别进行解释

1.2.1 为什么主要程序在第二目录下

为了把主要的程序分离出来,放在第二目录下面,这样的待会打包以后多出很多文件夹就不会对源码造成干扰.

当然,由于把程序放在了第二目录下面,所以,脚本里面的from import语句应该使用相对路径导入.

相对路径导入的的时候需要注意运行的时候使用如下命令

python3 -m danmufm.danmu [xxxx]

1.2.2 setup.cfg

填写如下内容即可.

[metadata]

description-file = README.md

然后去写Markdown的Readme就好了.

1.2.3 setup.py

这个是重头戏了.

setup这个py文件就是打包配置文件.对这个程序是谁的,有什么依赖,入口是什么,等等等等的配置.

#-*- encoding: UTF-8 -*-

from setuptools import setup, find_packages

"""

打包的用的setup必须引入，

"""

VERSION = '0.1.1'

setup(name='danmu.fm',

version=VERSION,

description="a tiny and smart cli player of douyutv,ximalayad,anmu based on Python",

long_description='just enjoy',

classifiers=[], # Get strings from ?%3Aaction=list_classifiers

keywords='python douyu danmu danmu.fm terminal',

author='twocucao',

author_email='[email protected]',

url='',

license='MIT',

packages=find_packages(),

include_package_data=True,

zip_safe=True,

install_requires=[

'requests',

entry_points={

'console_scripts':[

'danmu.fm = danmufm.danmu:main'

]

)

官方有distutils这个包管理器工具,设置也非常的简单,只是,它不支持entry_points属性,由于无法使用entry_point,也就无法通过命令来跳转到指定模块运行程序,这也就意味着,官方工具不方便写成命令行.还是setuptools好.

上面需要注意的就是install_requires可以添加依赖.其他的你猜都可以猜出来是做什么的.自己去看代码,我就不多说了.

2.发布

所谓的发布,就是将打包好的程序的某个版本发布到某个仓库中.

2.1.注册pypi账户

到这个上面注册账号:

2.2.注册在账户下面注册Python包

进入对应项目根文件,然后执行

python3 setup.py register

这一步程序会让你输入刚刚注册的账号和密码,然后注册该包.注册该包以后,你就有了一个小仓库.可以存放不同版本的danmu.fm.

注册的仓库是可以在这个地址看到的,

2.3.上传打包好的Python命令行工具.

这里需要借助一个小工具,twine.twine是一个更加安全方便上传打包好的代码的工具.

pip3 install twine

接着开始打包,打包成两个版本,一个是不需要build的版本,另一个是需要build的版本(顺带吐槽下,这两个诡异的命名).

python setup.py sdist bdist_wheel

于是剩下来的就显而易见了,上传build完毕的程序到仓库中.

twine upload dist/danmu.fm-0.1.2*

于是,安装一下,测试是否成功

pip3 install danmu.fm --upgrade

命令行的工具是这样使用的.

danmu.fm -q 2 -v 1

3.完善

不断的完善代码,然后打包终端程序发布到仓库给别人用,这就是整个的PIP打包发布流程.

这个时候,你可能需要使用版本控制软件.

你可能需要增多的代码的测试.

如下；

py如果没有Qt \\ bin,您可以复制本文件Qt网站。如果找不到现有PyQt5插件目录的错误出现在包装过程中,然后,1)找到PyQt5文件夹\/图书馆\/插件路径下蟒蛇目录下安装,并复制内容2)按照下面的错误报告一个句子,例如,如下:路径检查:_build \/图书馆\/插件的内部去C驱动和创建它们。最后,将刚才复制的复制进去,然后再做一次,包成功。特别注意:如果你发现你可以在你的电脑打开它的包装完成后,但你不能打开它在别人的电脑,错误报告如下:xxx未能执行脚本。在这个时候,我们需要替换上面的命令在步骤4 w c,然后删除所有的东西都打包和重新包装。c程序可以打开终端窗口cmd的形式,这样操作失败时,将一个特定的错误报告,具体的错误将被修改。

什么是pypi

简单的说pypi是一个python包的仓库，里面有很多别人写好的python库，你可以通过easy_install或者pip进行安装,方便用户更方面的使用你的代码模块。

将代码打包并上传到pypi上，大体上分为以下几步：

1、整理代码的目录结构，方便打包和python的import，为了方便引用，需要将代码模块变成一个包，所以需要将功能代码用目录来整合方便引用，并且需要创建__init__文件，__init__中可以没有内容，也可以在__init__文件中进行import（from .extractor import Document）操作，以减少整体模块引用时import的层数，避免错误。

[html] view plain copy

├── ./tidypage

│ ├── ./tidypage/cleaners.py

│ ├── ./tidypage/extractor.py

│ ├── ./tidypage/__init__.py

│ └── ./tidypage/titles.py

2、功能模块的目录整理好后，就可以开始整理和添加发布到pypi上所使用的文件了

tidy_page

├── LICENSE

├── README.rst

├── requirements.txt

├── setup.py

├──tidypage

│ ├──cleaners.py

│ ├──extractor.py

│ ├──__init__.py

│ └──titles.py

就是将原来的目录深移一层，文件夹名称可以根据自己意愿。然后在到第一层的目录下创建些特殊文件，具体你可以看看下面这个文件结构你就明白了

LICENSE文件是授权文件，比如：MIT license， APACHE license

README.rst 文件想必大家都不陌生，其实就是项目介绍和使用说明

setup文件才是重点，是python模块安装所需要的文件，它的格式如下：

#!/usr/bin/env python

from __future__ import print_function

from setuptools import setup, find_packages

import sys

setup(

name="tidy-page",

version="0.1.1",

author="Desion Wang",

author_email="[email protected]",

description="html text parser,get the content form html page",

long_description=open("README.rst").read(),

license="MIT",

url="https://github.com/desion/tidy_page",

packages=['tidypage'],

install_requires=[

"beautifulsoup4",

lxml_requirement

classifiers=[

"Environment :: Web Environment",

"Intended Audience :: Developers",

"Operating System :: OS Independent",

"Topic :: Text Processing :: Indexing",

"Topic :: Utilities",

"Topic :: Internet",

"Topic :: Software Development :: Libraries :: Python Modules",

"Programming Language :: Python",

"Programming Language :: Python :: 2",

"Programming Language :: Python :: 2.6",

"Programming Language :: Python :: 2.7",

) NAME 名字，一般放你包的名字即可PACKAGES 包含的包，可以多个，这是一个列表DESCRIPTION 关于这个包的描述LONG_DESCRIPTION 参见read方法说明KEYWORDS 关于当前包的一些关键字，方便PyPI进行分类。AUTHOR 谁是这个包的作者，写谁的名字吧AUTHOR_EMAIL 作者的邮件地址URL 你这个包的项目地址，如果有，给一个吧，没有你直接填写在PyPI你这个包的地址也是可以的VERSION 当前包的版本，这个按你自己需要的版本控制方式来LICENSE 授权方式INSTALL_REQUIRES 模块所依赖的python模块

文中的classifiers的内容并不是随便填写的，你需要参照本文参考文档中的PyPI Classifiers来写

3、开始使用Distutils进行打包

为了保证效果，在打包之前我们可以验证setup.py的正确性，执行下面的代码

python setup.py check

输出一般是running check如果有错误或者警告，就会在此之后显示没有任何显示表示Distutils认可你这个setup.py文件。

如果没有问题，那么就可以正式打包，执行下面的代码：

python setup.py sdist

执行完成后，会在顶层目录下生成dist目录和egg目录

tidy_page

├── tidy_page/dist

│ ├── tidy_page/dist/tidy-page-0.1.0.tar.gz

│ └── tidy_page/dist/tidy-page-0.1.1.tar.gz