一个Python包,用于基本的CLI和GUI用户界面
bun的Python项目详细描述
包
Bun(BasicUseri^{str1}$n接口)是一个用于基本用户界面的小Python包。在
目录
- Introduction
- Installation
- Usage
- Known issues and limitations
- Getting help
- Contributing
- License
- Authors and history
- Acknowledgments
简介
这个软件包源于同时满足两个目标的愿望:(1)拥有尽可能简单的编码接口,用于打印彩色编码的消息并从用户处获取基本信息;(2)让用户选择在运行时使用命令行界面(CLI)或图形用户界面(GUI)。结果是Bun(^{str1}$Basic^{str1}$Useri^{str1}$n接口)。它提供了inform
、warn
、alert
等函数,可以在如下代码中使用:
ifwritable(dest_dir):inform(f'Will write output to {dest_dir}.')else:alert(f'Output destination {dest_dir} is not writable.')
Bun很简单,功能有限,在设计上也有些固执己见,但它满足了许多程序的需要。Bun包装了Rich和{a16}等包,以提供简单的高级调用。以下是使用Bun的应用程序的一些输出示例:
在
许多Python的用户界面包已经存在,但是它们的使用需要配置和更复杂的代码才能使用。Bun的目标是更简单。在
安装
下面的说明假设您的计算机上安装了Python解释器;如果不是这样,请先install Python version 3并熟悉在系统上运行Python程序。在
在Linux、macOS和Windows操作系统上,您应该能够使用^{bun
,请运行以下命令:
作为从PyPI获取的替代方法,您可以使用pip
直接从GitHub安装{
python3 -m pip install git+https://github.com/caltechlibrary/bun.git
使用
[。。。即将到来。。。]
已知问题和限制
[。。。即将到来。。。]
寻求帮助
如果发现问题,请在此存储库的the GitHub issue tracker中提交。在
贡献
我们将很高兴得到您的帮助和参与增强Bun!请访问guidelines for contributing获取一些入门提示。在
许可证
加州理工学院图书馆制作的软件版权所有(C)2020,加州理工学院。本软件以BSD/MIT类型的许可证免费分发。有关详细信息,请参阅LICENSE文件。在
作者与历史
我在实现Holdit时开发了这段代码的第一个版本。从那时起,我开始在我编写的每个Python软件包中使用这些代码,首先是复制粘贴代码(最初非常短),最后创建一个文件模块(名为ui.py
)。这显然是一个次优的方法。最后,在2020年,我决定是时候把它拆分成一个独立的Python包了。在
致谢
这项工作是由加州理工学院资助的。在
bun的vector artwork用作此存储库的图标,由Noun项目中的Vectors Market创建。它是根据Creative Commons CC-BY 3.0许可证授权的。在
- 项目
标签: