一个简单的changelog解析器
simplechanges的Python项目详细描述
简单的改变
Simple Changes是一种非常简单的changelog格式,它跟踪更改并以编程方式调用它们。文件格式非常容易理解,您可以使用这个包来解析文件并在变更日志中获取信息。简单的变化是用来分析游戏的变化日志和提供最新版本的信息给玩家,但这个库可以在任何地方使用。在
要求
- Python 2.7+
- 诗歌包经理(建筑)
入门
快速入门:安装在PyPI
简单的更改捆绑在无脚本中,但您可以将其安装到您的项目中,从PyPI with pip:
pip install simplechanges
从源安装
要从源代码安装简单的更改,请首先通过git clone
从GitHub克隆存储库。你还需要安装诗歌。在源的根目录下,运行以下命令:
生成的控制盘文件将在dist目录中可用。在
语法
- 注释被包装在
/*
和*/
中。在 - 版本用方括号表示:
[v1.0.0]
。在 - 音符在开头用破折号表示,结尾用换行符表示。在
Note: To get the
latest
version to work in the parser, always place the latest version at the top of the file.
示例文件
/*
Changelog Test
*/
[v1.0.1]
- Made a small bugfix.
[v1.0.0]
- Launched!
- I ate cheese.
使用
使用这个软件包相对容易。要获取变更日志中的最新版本,假设变更日志已建立:
fromsimplechangesimportSimpleChangesParserchangelog=SimpleChangesParser("changelog.changes")changelog.parse()version,notes=changelog.latest
解析后,还可以浏览特定版本:
fromsimplechangesimportSimpleChangesParserchangelog=SimpleChangesParser("changelog.changes")changelog.parse()version,notes=changelog.versions["v1.0.0"]
许可证
此代码是根据Mozilla公共许可证v2.0授权的。在
- 项目
标签: