跳转到主要内容

did - 你上周、这个月、去年做了什么?

项目描述

你上周、这个月、去年做了什么?

描述

舒适地收集特定周、月、季度、年或选定日期范围的报告数据(例如已提交更改的列表)。默认情况下,会报告本周的所有可用统计数据。

根据配置,did在提供的时间框架内探索用户给定工具的活动。例如,检查所有配置的git存储库的提交列表,或联系Bugzilla以搜索创建、修改或关闭的bug。

一些信息(如git提交)是从本地文件系统中收集的,但通常单个插件会联系工具的远程API以查询最新数据。对于提供公共API的工具,无需身份验证。一些插件支持Kerberos,其他需要创建身份验证令牌。请参阅各个插件的文档以获取详细信息。

概述

用法简单明了

did [this|last] [week|month|quarter|year] [opts]

示例

收集当前周的所有统计信息

did

显示今天、昨天和上周五的所有统计信息

did today
did yesterday
did last friday

收集上个月的统计信息

did last month

查看did --help获取所有可用统计信息的完整列表。

选项

可用选项列表取决于已配置的插件。以下是与任何插件无关的一般选项列表

选择

除非在配置文件中定义,否则需要在命令行上提供至少一个电子邮件地址。使用完整的电子邮件地址格式Name Surname <email@example.org>来在报告输出中显示全名。对于日期值,可以使用今天昨天代替完整的日期格式。

--email=EMAILS

用户电子邮件地址

--since=SINCE

起始日期,格式为YYYY-MM-DD

--until=UNTIL

结束日期,格式为YYYY-MM-DD

格式

默认输出为79个字符宽的纯文本。这可以通过--width参数进行调整。要完全禁用缩短,请使用--width=0。默认宽度值也可以保存在配置文件中。使用--format=wiki来启用简单的MoinMoin wiki语法或使用--format=markdown来启用markdown语法。对于支持这些语法的统计信息,可以使用--brief--verbose来指定要显示的不同详细程度。

–format {text,markdown,wiki}

输出样式,默认:text

--width=WIDTH

报告输出的最大宽度(默认:79)

--brief

仅显示简要摘要,不列出单个条目

--verbose

包含更多详细信息(如修改过的git目录)

工具

可以使用多个电子邮件地址来合并团队报告或收集所有电子邮件别名。对于此用例,可以使用--total--merge来分别追加总体摘要或合并所有结果到一个报告中。使用--debug或将环境变量DEBUG设置为1到5来设置所需的调试级别。

--config=FILE

使用替代配置文件(默认:'config')

--total

在列出单个用户后追加总体统计信息

--merge

将所有用户的统计信息合并到单个报告中

--debug

开启调试输出,不要捕获异常

查看did --help获取所有可用选项的完整列表。

安装

直接从Fedora/Copr仓库安装

yum install did

或使用pip从Python包索引安装

pip install did

您可能需要安装一些或所有额外需求

pip install did[plugin]
pip install did[all]

要在docker容器中构建和执行,运行

make run_docker

查看文档以获取有关安装选项的更多详细信息。

配置

配置文件~/.did/config用于存储一般设置和单个报告的配置

[general]
email = "Petr Šplíchal" <psplicha@redhat.com>
width = 79

[header]
type = header
highlights = Highlights
joy = Joy of the week ;-)

[tools]
type = git
did = /home/psss/git/did

[tests]
type = git
tests = /home/psss/git/tests/*

[trac]
type = trac
prefix = TT
url = https://some.trac.com/trac/project/rpc

[bz]
type = bugzilla
prefix = BZ
url = https://bugzilla.redhat.com/xmlrpc.cgi

[footer]
type = footer
next = Plans, thoughts, ideas...
status = Status: Green | Yellow | Orange | Red

查看插件文档以获取特定插件可用的选项的更详细描述。您也可以直接查看Python模块文档,例如pydoc did.plugins.git或使用包和Web文档中提供的示例配置。

作者

Petr Šplíchal, Karel Šrot, Lukáš Zachar, Matěj Cepl, Ondřej Pták, Chris Ward, Tomáš Hofman, Martin Mágr, Stanislav Kozina, Paul Belanger, Eduard Trott, Martin Frodl, Randy Barlow, Alois Mahdal, Evgeni Golov, Stanislav Ochotnický, Maroš Kopec, Robbie Harwood, Christopher Sams, Thomas Heute, Giulio Fidente, Han Han, Qiao Zhao, Henrique Ferreiro, Jakub Vávra, Luigi Toscano, Lukáš Zapletal, Maryna Nalbandian, Dominika Hoďovská, Jakub Haruda, Han Han, Štěpán Němec, Evgeny Fedin, Mikel Olasagasti Uranga, Miloš Malík, Jeffrey Bastian, Côme Chilliet, Marcin Juszkiewicz, Tomáš Kopeček, Konrad Kleine, Sandro Bonazzola 和 Morgan Weetman。

状态

https://badge.fury.io/py/did.svg https://coveralls.io/repos/github/psss/did/badge.svg https://img.shields.io/pypi/dm/did.svg https://img.shields.io/pypi/l/did.svg https://readthedocs.org/projects/did/badge/

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

此版本没有可用的源分布文件。请参阅生成分发存档的教程

构建分布

did-0.21.1-py3-none-any.whl (81.9 kB 查看哈希值)

上传时间 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面