从gitlab问题、项目和组导出各种数据集
gitlab-exporter的Python项目详细描述
Gitlab导出器
python工具,用于命令行从gitlab导出各种数据集,如项目问题和组里程碑日期。由于在子模块上构建了一个api,因此可以很好地扩展。
gitlab exporter基于argparse,并在引擎盖下使用python-gitlab。
动机
在Tuhh,我们经常使用Gitlab CE进行项目管理。社区版(community edition,ce)缺少gitlab高级版本所具有的一些功能。由于我们想独立于麻省理工学院许可的gitlab发行版,我们必须自己实现缺失的功能。
让所有同事都与gitlab一起工作需要一些时间和耐心。对他们中的许多人来说,gitlab并不是他们开始工作时首先打开的工具。因此,一些工作区和助手函数可以使他们的工作更加方便和有趣,因为并不是所有的工作区都是程序员。
gitlab exporter就是这样一个帮助工具。它的目的是从gitlab中获取数据,并将其定位到同事的个人数字环境中,如日历、办公程序等。
安装
要求
您至少需要在系统上安装
- python 3.6.x
- 潘多克2.x
从源安装
转到the repository并获取源。
使用pip
安装gitlab exporter是一个python工具,可以很容易地与pip一起安装。
pip install gitlab-exporter
使用pip安装之后,您应该能够在shell中使用命令gitlab-exporter
。
了解API
要了解gitlab exporter的api,请键入
gitlab-exporter -h
安装后。有几个用于不同目的的子模块。了解这些子模块的api,只需键入例如
gitlab-exporter gmd -h
获取将组里程碑日期导出到ICS文件的子模块的帮助。
子模块和示例
gitlab exporter为不同的目的提供了几个子模块。
gmd
-组里程碑日期
将组级别里程碑的日期和说明导出到ICS文件。然后您可以将此文件导入到您选择的日历中。
示例:
gitlab-exporter https://my-gitlab.com A2DF6HE6R7C88C9AE gmd 1234 milestones.ics
该命令由gitlab实例、私有令牌、子模块名、组id和ics文件的文件名组成。
pi
-项目问题
将属于某个项目的问题导出到CSV文件。
gitlab-exporter https://my-gitlab.com A2DF6HE6R7C88C9AE gi 2345 issues.csv
该命令由gitlab实例、私有令牌、子模块名、项目id和csv文件名组成。
用Docker自动完成无聊的事情
如果ci/cd组件与gitlab一起运行,docker可以很容易地从gitlab构建导出。
进一步的文件正在路上…
测试
有一些,但会尽快更新到pytest。
许可证
汉堡理工大学(TUHH)Axel dürkop 2019版权所有
此软件是根据Apache License, Version 2.0