1DID(1) User Commands DID(1)
2
6 did - What did you do last week, month, year?
7
9 Comfortably gather status report data (e.g. list of committed changes)
10 for given week, month, quarter, year or selected date range. By default
11 all available stats for this week are reported.
12 Based on the config, did explores user's activity for given tools in
14 provided time frame. For example checks all configured git repositories
15 for the list of commits or contacts Bugzilla to search for bugs cre‐
16 ated, modified or closed.
17 Some information (like git commits) is gathered from the local file
19 system, but usually individual plugins are contacting remote API of the
20 tool to query for the latest data. For tools which provide a public API
21 there is no need for authentication. Some plugins support Kerberos,
22 other need to create an authentication token. See individual plugin
23 documentation for details.
24
26 Usage is straightforward:
27 did [this|last] [week|month|quarter|year] [opts]
29
31 Gather all stats for current week:
32 did
34 Show me all stats for today, yesterday, last Friday:
36 did today
38 did yesterday
39 did last friday
40 Gather stats for the last month:
42 did last month
44 See did --help for complete list of available stats.
46
48 The list of available options depends on which plugins are configured.
49 Here's the list of general options which are not related to any plugin:
50 Select
52 At least one email address needs to be provided on command line unless
53 defined in the config file. Use the complete email address format Name
54 Surname <email@example.org> to display full name in the report output.
55 For date values today and yesterday can be used instead of the full
56 date format.
57 --email=EMAILS
59 User email address(es)
60 --since=SINCE
62 Start date in the YYYY-MM-DD format
63 --until=UNTIL
65 End date in the YYYY-MM-DD format
66 Format
68 The default output is plain text of maximum width 79 characters. This
69 can be adjusted using the --width parameter. To disable shortening al‐
70 together use --width=0. The default width value can be saved in the
71 config file as well. Use --format=wiki to enable simple MoinMoin wiki
72 syntax or --format=markdown to enable markdown syntax. For stats which
73 support them, --brief and --verbose can be used to specify a different
74 level of detail to be shown.
75 --format {text,markdown,wiki}
77 Output style, default: text
78 --width=WIDTH
80 Maximum width of the report output (default: 79)
81 --brief
83 Show brief summary only, do not list individual items
84 --verbose
86 Include more details (like modified git directories)
87 Utils
89 Multiple emails can be used to put together a team report or to gather
90 stats for all of your email aliases. For this use case --total and
91 --merge can be used to append the overall summary at the end or merge
92 all results into a single report respectively. Use --debug or set the
93 environment variable DEBUG to 1 through 5 to set the desired level of
94 debugging.
95 --config=FILE
97 Use alternate configuration file (default: 'config')
98 --total
100 Append total stats after listing individual users
101 --merge
103 Merge stats of all users into a single report
104 --debug
106 Turn on debugging output, do not catch exceptions
107 See did --help for complete list of available options.
109
111 Install directly from Fedora/Copr repository:
112 yum install did
114 Or use pip to install from Python Package Index:
116 pip install did
118 You may want to install some or all extra requires:
120 pip install did[plugin]
122 pip install did[all]
123 To build and execute in a docker container, run:
125 make run_docker
127 See documentation for more details about installation options.
129
131 The config file ~/.did/config is used to store both general settings
132 and configuration of individual reports:
133 [general]
135 email = "Petr Šplíchal" <psplicha@redhat.com>
136 width = 79
137 [header]
139 type = header
140 highlights = Highlights
141 joy = Joy of the week ;-)
142 [tools]
144 type = git
145 did = /home/psss/git/did
146 [tests]
148 type = git
149 tests = /home/psss/git/tests/*
150 [trac]
152 type = trac
153 prefix = TT
154 url = https://some.trac.com/trac/project/rpc
155 [bz]
157 type = bugzilla
158 prefix = BZ
159 url = https://bugzilla.redhat.com/xmlrpc.cgi
160 [footer]
162 type = footer
163 next = Plans, thoughts, ideas...
164 status = Status: Green | Yellow | Orange | Red
165 See plugin documentation for more detailed description of options
167 available for particular plugin. You can also check python module docu‐
168 mentation directly, e.g. pydoc did.plugins.git or use the example con‐
169 fig provided in the package and web documentation.
170
172 Git: https://github.com/psss/did
173 Docs: https://did.readthedocs.io
175 Issues: https://github.com/psss/did/issues
177 Releases: https://github.com/psss/did/releases
179 Copr: https://copr.fedoraproject.org/coprs/psss/did
181 PIP: https://pypi.org/project/did
183
185 Petr Šplíchal, Karel Šrot, Lukáš Zachar, Matěj Cepl, Ondřej Pták, Chris
186 Ward, Tomáš Hofman, Martin Mágr, Stanislav Kozina, Paul Belanger, Ed‐
187 uard Trott, Martin Frodl, Randy Barlow, Alois Mahdal, Evgeni Golov,
188 Stanislav Ochotnický, Maroš Kopec, Robbie Harwood, Christopher Sams,
189 Thomas Heute, Giulio Fidente, Han Han, Qiao Zhao, Henrique Ferreiro,
190 Jakub Vávra, Luigi Toscano, Lukáš Zapletal, Maryna Nalbandian, Dominika
191 Hoďovská, Jakub Haruda, Han Han, Štěpán Němec, Evgeny Fedin, Mikel
192 Olasagasti Uranga, Miloš Malík, Jeffrey Bastian, Côme Chilliet, Marcin
193 Juszkiewicz, Tomáš Kopeček, Konrad Kleine, Sandro Bonazzola and Morgan
194 Weetman.
195
197 Copyright (c) 2015 Red Hat, Inc. All rights reserved.
198 This program is free software; you can redistribute it and/or modify it
200 under the terms of the GNU General Public License as published by the
201 Free Software Foundation; either version 2 of the License, or (at your
202 option) any later version.
203 August 2015 DID(1)