保姆级教程带你开发优质的Python库之中篇【命令行发行】_python 命令行开发指导(1)

给大家的福利

零基础入门

对于从来没有接触过网络安全的同学，我们帮你准备了详细的学习成长路线图。可以说是最科学最系统的学习路线，大家跟着这个大的方向学习准没问题。

同时每个成长路线对应的板块都有配套的视频提供：

因篇幅有限，仅展示部分资料

网络安全面试题

绿盟护网行动

还有大家最喜欢的黑客技术

网络安全源码合集+工具包

所有资料共282G，朋友们如果有需要全套《网络安全入门+黑客进阶学习资源包》，可以扫描下方二维码领取（如遇扫码问题，可以在评论区留言领取哦）~

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化资料的朋友，可以点击这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

  keywords=("pypi\_seed", "seed", "generator", "levin", "leixuewei"),
  description='A small tool to demo on upload package to pypi and utility scripts to generate a pypi seed',
  long_description="""A small tool to demo on upload package to pypi and utility scripts to generate a pypi seed!

Powered by py4ever team!“”",
author=‘levin’,
author_email=‘790839397@qq.com’, #项目联系人
url=‘https://github.com/py4ever/pypi_seed’,
#学委删简了一些，非本文重点的信息
entry_points={
‘console_scripts’: [
‘pypiseed = pypi_seed.main:main’,
‘pyseed = pypi_seed.main:main’
]
},
classifiers=[
‘Intended Audience :: Developers’ # 学委删简了一些支持多版本的，需要的去github或者gitee借鉴pypi_seed的setup.py
],
)

### 解释一下setup.py


简单理解，这个setup.py 就相当于一个开源模块的地图。


它包括了作者信息，项目说明，版本，项目链接，更重要的，安装后命令行的**程序入口就放在“entry\_points"**。


**设置了entry\_points, 我们使用pip工具安装这个模块的时候，它会自动帮我们创建相应的文件。**


比如上面的entry\_points是两个命令工具：


* pypiseed 为命令行工具，对等与调用pypi\_seed.main:main
* pyseed 为命令行工具，对等与调用pypi\_seed.main:main


#### 补充说明setup.py其他参数解释


重点是作者，项目名称，联系信息，下面整理解释：


* name ： 项目名称，特别重要！其他开发者通过这个来搜索你的库
* author : 作者
* keywords : 项目关键字
* description : 项目说明
* author\_email : 作者邮箱信息
* url : 项目主页


这些比较直白，根据开源工具的定位来编写完善。


项目说明如果写不下，就放置在long description字段。万一用户在用的时候有啥反馈，还能够联系到邮箱，或者通过项目主页继续互动，这样能够保持项目的不断完善，与时俱进！


## 第二步 开发一个命令行处理的Python程序


生成了程序入口了，我们可以通过

pyseed 参数 #调用pypi_seed了

好了，说完entry\_points, 它调用到了pypi\_seed.main:main。 学委已经帮大家看了源码了。


pypiseed / pyseed里面调用了一个程序内的show\_help 和args2dict 两个方法。


### 开源项目源码解析


这里是show\_help方法，重点是输出打印一些使用信息，和项目简易说明。

def show_help():
print(‘usage:’)
print(‘-h, --help: print help message.’)
print(‘-p, --project: your desired project name’)
print(‘-P, --path: where to save the sample project after code-generation’)
print(‘-a, --author: the author information’)
print(“===========================================”)
show_sample_run()
show_about()

这里就是本文的核心了，解析用户的输入。


为了解析方便，学委仅摘取了核心代码段，我们看一下。

import sys
import getopt

def args2dict():
argv = sys.argv[1:]
if ‘-h’ in argv or ‘–help’ in argv:
show_help()
exit(0)
try:
opts, args = getopt.getopt(argv, “p:P:a”,
[“path=”,
“author=”,
“project=”])
except Exception as e:
raise ValueError("Looks like missing value, please check usage by ‘-h’. Current error : %s " % str(e))
project = author = path = None
for opt, arg in opts:
if opt in [‘-p’, ‘–project’]:
project = arg
elif opt in [‘-a’, ‘–author’]:
author = arg
elif opt in [‘-P’, ‘–path’]:
path = arg
if project is None:
print("please input project with ‘-p’ or ‘–project’, e.g. -p my_project ")
raise ValueError(“Missing project”)
if author is None:
print("please input author with ‘-a’ or ‘–author’, e.g. -a whoami ")
raise ValueError(“Missing author”)
if path is None:
path = os.getcwd()
print(“path is not given, so will use default as current directory : %s” % path)
return dict(project=project, author=author, path=path)

#### 核心代码讲解


这里主要是分三步


* 获取终端参数，判断是否输出帮助
* 使用getopt内置库来解析p:P:a参数（-a, -P, -p) 处理为一个字典dict（管理project/author/path等信息)
* 返回字典给生成器调用，生成种子项目。


## 最后使用命令行调用你的库：


安装你的库：

pip install pypi_seed

**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

**[需要这份系统化资料的朋友，可以点击这里获取](https://bbs.csdn.net/topics/618540462)**

**一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！**