用于查找和映射对开放源代码项目的贡献的实用程序
mr.cabot的Python项目详细描述
关于
卡博特先生是一个允许软件项目绘制其贡献来源地图的工具。它从github、gmane和stackoverflow等公共源读取数据,并试图定位这些贡献者的物理位置。
基本用法
您需要自定义mr.cabot.cfg配置文件以匹配您的软件项目。基本格式是,sources行列出提供参与者列表的部分,users列出提供参与者列表的部分。
目前只有github源支持用户枚举,但stackoverflow和gmane都在可能的情况下提取地理位置信息。
示例
plone项目的当前示例生成以下内容:
源类型
Github
- 键入
- github
- 键
- 要扫描的组织的名称
- 令牌
- OAuth令牌,最好是具有repo作用域的令牌。见https://help.github.com/articles/creating-an-oauth-token-for-command-line-use
- 签出目录
吉特
- 键入
- 吉特
- 键
- git存储库的克隆url
堆栈溢出
- 键入 堆栈溢出
- 键
- 堆栈溢出时使用的标记
- 天
- 要下载的历史天数
gmane
- 键入
- gmane
- 键
- gmane新闻组的完整名称
- 消息
- 下载最后x条消息
输出类型
输出类型默认为google静态映射,但可以使用命令行上的“输出类型”进行选择。
可用选项有:
- 谷歌静态地图
- HTML
- kml
缓存
目前还不包括地理位置数据的缓存,但数据运行缓存在var/data下,文件名为yyy-mm-dd.pickle。这允许您在更改显示方法时重新运行旧数据集。
要加载pickle而不是重新扫描,请使用–pickle命令行选项:
./bin/cabot --pickle ./var/data/2013-01-05.pickle --output kml
此外,还有一个命令行选项可以跳过提取git存储库。这对于最初调整配置文件时重新运行非常有用,因为更新git是最慢的部分:
./bin/cabot -N --output kml