上个星期,月,年你做了什么?
did的Python项目详细描述
你上星期,月,年做了什么?
说明
轻松收集状态报告数据(例如,提交的列表 更改)指定周、月、季、年或选定日期 范围默认情况下,将报告本周的所有可用统计信息。
基于配置,did探索给定用户的活动 提供的时间范围内的工具。例如,检查所有配置的 Bugzilla提交或联系人列表的Git存储库 搜索创建、修改或关闭的Bug。
一些信息(如git提交)是从本地 文件系统,但通常每个插件都与远程 用于查询最新数据的工具的API。对于那些 提供一个公共api不需要身份验证。一些 插件支持kerberos,其他需要创建身份验证 代币。有关详细信息,请参阅各个插件文档。
概要
用法很简单:
did [this|last] [week|month|quarter|year] [opts]
示例
收集本周的所有统计信息:
did
显示今天/昨天的所有统计信息:
did today did yesterday
收集上个月的统计信息:
did last month
有关可用统计信息的完整列表,请参见did --help。
选项
可用选项的列表取决于哪些插件 已配置。下面是一些常规选项 与任何插件相关:
选择
命令行上至少需要提供一个电子邮件地址 除非在配置文件中定义。使用完整的电子邮件地址 格式化Name Surname <email@example.org>以显示全名 在报告输出中。对于日期值today和yesterday 可用于代替完整日期格式。
--email=EMAILS | User email address(es) |
--since=SINCE | Start date in the YYYY-MM-DD format |
--until=UNTIL | End date in the YYYY-MM-DD format |
格式
默认输出为最大宽度79字符的纯文本。 这可以使用--width参数进行调整。禁用 缩短全部使用--width=0。默认宽度值 也可以保存在配置文件中。使用--format=wiki到 启用简单的moinmoin wiki语法。对于支持他们的数据, --brief和--verbose可用于指定不同的 显示详细程度。
--format=FMT | Output style, possible values: text (default) or wiki |
--width=WIDTH | Maximum width of the report output (default: 79) |
--brief | Show brief summary only, do not list individual items |
--verbose | Include more details (like modified git directories) |
utils
多封电子邮件可用于组合团队报告或 收集所有电子邮件别名的统计信息。对于这个用例 --total和--merge可用于附加 最后汇总或将所有结果合并到一个报表中 分别是。使用--debug或设置环境变量 DEBUG设置为1到5,以设置所需的调试级别。
--config=FILE | Use alternate configuration file (default: ‘config’) |
--total | Append total stats after listing individual users |
--merge | Merge stats of all users into a single report |
--debug | Turn on debugging output, do not catch exceptions |
有关可用选项的完整列表,请参见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文档中提供的示例配置。
链接
吉特: https://github.com/psss/did
文件: https://did.readthedocs.io
问题: https://github.com/psss/did/issues
发布: https://github.com/psss/did/releases
科普尔: https://copr.fedoraproject.org/coprs/psss/did
PIP编号: https://pypi.org/project/did
版权所有
版权所有(c)2015 Red Hat,Inc.保留所有权利。
此程序是免费软件;您可以重新分发它和/或 根据GNU通用公共许可条款修改为 由自由软件基金会出版;或 许可证,或(由您选择)任何更高版本。