快速构建CLI程序并发布到PyPi
构造一个简单的CLI程序
typer
这个从去年就被各种营销号吹成Web框架的 第三方库, 与 FastAPI 同出一人之手,它不是Web框架,它是一个用来构建CLI程序的库,我们就简单搞个例子
# 更多用法,看文档
import typer
# 实例一下
app = typer.Typer()
# 加到命令组中 hello
@app.command()
def hello(name: str):
typer.echo(f"Hello {name}")
# 加到命令组中 goodbye 接收 一个必要参数name, --formal 可修改默认值参数
@app.command()
def goodbye(name: str, formal: bool = False):
if formal:
typer.echo(f"Goodbye Ms. {name}. Have a good day.")
else:
typer.echo(f"Bye {name}!")
poetry
依赖环境和包管理器,个人觉得最大的亮点就是可以直接打包发布到PyPi上
pip install poetry 进行安装
# 常用命令
1. 在已有项目中初始化(图方便就一直回车): poetry init
2. 完全初始化一个项目: poetry new 项目名
# 上述内容 一路回车之后 得到一个pyproject.toml文件
3. 添加依赖库并安装: poetry add typer
... 其他命令 ... 各位自己翻文档吧
正片开始
新建一个目录
tclidemo
poetry init
一路回车poetry add typer
安装typer目录下新建一个同名的包(也可不同名)
在
包
里面新建一个main.py
内容就是上面typer
中的内容pyproject.toml
添加[tool.poetry.scripts]
后如下[tool.poetry]
# 这个name 必须和 我们要打包那个目录一个名称,且不能和pypi已有的包冲突
name = "tclidemo"
version = "0.1.4" # 包版本号 安装时 最好指定版本安装 pip install xx==0.1.2
description = ""
authors = ["zy7y <xxxxxxx@163.com>"] [tool.poetry.dependencies]
python = "^3.9"
typer = "^0.4.0" [tool.poetry.dev-dependencies] [build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api" [tool.poetry.scripts]
# 前面是命令 开头 , = 后面是 指定typer实例, 对应的就是 打包包名.模块名(main.py文件).typer对象名
tdo = 'tclidemo.main:app'打包&上传pypi
PyPI · The Python Package Index
# 执行后在当前目录下生成一个dist目录,poetry 和 npm 命令还差不多....
poetry build (venv) E:\coding\tree-cli>poetry build
Building tclidemo (0.1.4)
- Building sdist
- Built tclidemo-0.1.4.tar.gz
- Building wheel
- Built tclidemo-0.1.4-py3-none-any.whl # 上传
poetry publish # 之后会要求输入 pypi 的账号密码(没有的先去注册 https://pypi.org/) (venv) E:\coding\tree-cli>poetry publish Username: zy7y
Password:
Publishing tclidemo (0.1.4) to PyPI
- Uploading tclidemo-0.1.4-py3-none-any.whl 0%
- Uploading tclidemo-0.1.4-py3-none-any.whl 100%
- Uploading tclidemo-0.1.4-py3-none-any.whl 100%
- Uploading tclidemo-0.1.4.tar.gz 0%
- Uploading tclidemo-0.1.4.tar.gz 100%
- Uploading tclidemo-0.1.4.tar.gz 100%
如果没报错,那就稳了,新起个虚拟环境
python -m venv venv
# 安装上传的包 , 如果确实上传了装不上 最好等个一分钟哦
pip install tclidemo==0.1.4 # 执行tdo --help
tdo --help
(venv) C:\Users\win10\Desktop\apiAutoTest>tdo --help
Usage: tdo [OPTIONS] COMMAND [ARGS]... Options:
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell, to
copy it or customize the installation. --help Show this message and exit. Commands:
goodbye
hello
最后
两个库官方文档如下,更多用法等你发掘。 可以试试 pip install tclidemo==0.1.4 哦
https://typer.tiangolo.com/ # typer
https://python-poetry.org/docs/ # poetry
参考文档:https://click-docs-zh-cn.readthedocs.io/zh/latest/setuptools.html
快速构建CLI程序并发布到PyPi的更多相关文章
- 使用SpringBoot快速构建应用程序
1.Spring MVC和Spring Boot自带的web构建方式有所区别.Spring提供了spring-boot-starter-web自动配置模块. 2. 添加如下依赖 <depende ...
- 5分钟快速构建苹果IPA免费发布服务器
在ios的开发中, 通过苹果的各种秘钥加密, 我们会生成一个.ipa文件,这就是我们的应用软件的安装包. 这个文件是能被安装到iphone/ipad上的.可是,如何才能让不在身边的人安装上这个应用呢? ...
- Apache Commons CLI官方文档翻译 —— 快速构建命令行启动模式
昨天通过几个小程序以及Hangout源码学习了CLI的基本使用,今天就来尝试翻译一下CLI的官方使用手册. 下面将会通过几个部分简单的介绍CLI在应用中的使用场景. 昨天已经联系过几个基本的命令行参数 ...
- 快速构建Windows 8风格应用3-打包发布应用
原文:快速构建Windows 8风格应用3-打包发布应用 本篇博文主要介绍如何打包应用程序,成功后如何部署应用程序,最后介绍如何发布应用程序到应用商店中. 如何打包Windows 8风格应用程序呢? ...
- 快速构建Windows 8风格应用36-商店应用发布流程
原文:快速构建Windows 8风格应用36-商店应用发布流程 引言 在发布应用之前,我们需要注册开发者账号才能够发布应用.我们可以登录https://appdev.microsoft.com/Sto ...
- 快速构建Windows 8风格应用37-常见发布注意事项
原文:快速构建Windows 8风格应用37-常见发布注意事项 引言 通常我们发布Windows Store应用失败后,会返回一些错误需要我们去修改.我之前在给学生做培训的时候发现大部分同学应用被打回 ...
- 使用eclipse和JavaFX Scene Builder进行快速构建JavaFX应用程序
http://blog.csdn.net/wingfourever/article/details/7726724 使用eclipse和JavaFX Scene Builder进行快速构建JavaFX ...
- Java Swing快速构建窗体应用程序
以前接触java感觉其在桌面开发上,总是不太方便,没有一个好的拖拽界面布局工具,可以快速构建窗体. 最近学习了一下NetBeans IDE 8.1,感觉其窗体设计工具还是很不错的 , 就尝试一下做了一 ...
- 两小时快速构建微信小程序
小程序在2017年1月上线之初,被社会极力吹捧,刻意去将其制造为一个“风口”,透支其价值.但是在之后一个月里,石破天惊迅速归为沉寂.媒体又开始过度消费小程序,大谈其鸡肋之处. 个人认为小程序的一个分水 ...
随机推荐
- js学习笔记之正则
() 是为了提取匹配的字符串.表达式中有几个()就有几个相应的匹配字符串.(\s*)表示连续空格的字符串.[]是定义匹配的字符范围.比如 [a-zA-Z0-9] 表示相应位置的字符要匹配英文字符和数字 ...
- vue中this.$router.push()路由传值和获取的两种常见方法
1.路由传值 this.$router.push() (1) 路由跳转使用router.push()方法,这个方法会向history栈添加一个新纪录,所以,当用户点击浏览器后退按钮时,会回到之前的 ...
- python打包exe之pyinstaller用法
pyinstaller可以将python写好的脚本打包成exe文件,方便windows用户在没有python环境下运行.这个程序完全跨平台,包括Windows.Linux.Mac OS X等多个操作系 ...
- 记一次 .NET 某智慧水厂API 非托管内存泄漏分析
一:背景 1. 讲故事 七月底的时候有位朋友在wx上找到我,说他的程序内存占用8G,托管才占用1.5G,询问剩下的内存哪里去了?截图如下: 从求助内容看,这位朋友真的太客气了,动不动就谈钱,真伤感情, ...
- Java代码操作zookeeper
.personSunflowerP { background: rgba(51, 153, 0, 0.66); border-bottom: 1px solid rgba(0, 102, 0, 1); ...
- git submodule 操作
git submodule foreach git status 举一反三,对所有子库的操作,都可以使用 git submodule foreach 做前缀 foreach,可以记忆为for each ...
- 寻找写代码感觉(二)之 Spring Boot 项目属性配置
一.前言 写代码就和恋爱一样,有反馈就要趁热打铁,搞完了项目搭建,接下来就来搞搞项目配置. 二.IDEA设置 1.编码配置 这里所说的就是代码的编码格式,你可以不设置,但是可能要面临的是,很多未知的麻 ...
- 为什么网络损伤仪WANsim中没有流量通过
在使用网络损伤仪 WANsim 的过程中,有时候发现网损仪中没有流量通过.有些小伙伴可能会想:自己所有配置都是正确的 ,为什么会没有流量通过呢? 有可能,是你忽略了一些东西. 下面,我总结了一些导致网 ...
- Docker小白到实战之容器数据卷,整理的明明白白
前言 上一篇把常用命令演示了一遍,其中也提到容器的隔离性,默认情况下,容器内应用产生的数据都是由容器本身独有,如果容器被删除,对应的数据文件就会跟着消失.从隔离性的角度来看,数据就应该和容器共存亡:但 ...
- mysql删除大表更快的办法
实现:巧用LINK(硬链接),原理:linux文件系统中硬链接相当于文件的入口,记录着ionde的信息.一个文件存在多个硬连接时,删除一个硬链接不会真正的删除ionde(存储文件的数据) # 创建硬链 ...