did 0.11.4

Description

Comfortably gather status report data (e.g. list of committed changes) for given week, month, quarter, year or selected date range. By default all available stats for this week are reported.

Based on the config, did explores user’s activity for given tools in provided time frame. For example checks all configured git repositories for the list of commits or contacts Bugzilla to search for bugs created, modified or closed.

Some information (like git commits) is gathered from the local file system, but usually individual plugins are contacting remote API of the tool to query for the latest data. For tools which provide a public API there is no need for authentication. Some plugins support Kerberos, other need to create an authentication token. See individual plugin documentation for details.

Synopsis

Usage is straightforward:

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

Examples

Gather all stats for current week:

did

Show me all stats for today/yesterday:

did today
did yesterday

Gather stats for the last month:

did last month

See did --help for complete list of available stats.

Options

The list of available options depends on which plugins are configured. Here’s the list of general options which are not related to any plugin:

Install

Install directly from Fedora/Copr repository:

yum install did

Or use pip to install from Python Package Index:

pip install did

You may want to install some or all extra requires:

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

To build and execute in a docker container, run:

make run_docker

See documentation for more details about installation options.

Config

The config file ~/.did/config is used to store both general settings and configuration of individual reports:

[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

See plugin documentation for more detailed description of options available for particular plugin. You can also check python module documentation directly, e.g. pydoc did.plugins.git or use the example config provided in the package and web documentation.

Links

Git: https://github.com/psss/did

Docs: https://did.readthedocs.io

Issues: https://github.com/psss/did/issues

Releases: https://github.com/psss/did/releases

Copr: https://copr.fedoraproject.org/coprs/psss/did

PIP: https://pypi-hypernode.com/project/did

Authors

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 and Robbie Harwood.

Copyright

Copyright (c) 2015 Red Hat, Inc. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Status