1DID(1)                           User Commands                          DID(1)
2
3
4

NAME

6       did - What did you do last week, month, year?
7

DESCRIPTION

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
13       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
18       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

SYNOPSIS

26       Usage is straightforward:
27
28          did [this|last] [week|month|quarter|year] [opts]
29

EXAMPLES

31       Gather all stats for current week:
32
33          did
34
35       Show me all stats for today, yesterday, last Friday:
36
37          did today
38          did yesterday
39          did last friday
40
41       Gather stats for the last month:
42
43          did last month
44
45       See did --help for complete list of available stats.
46

OPTIONS

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
51   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
58       --email=EMAILS
59              User email address(es)
60
61       --since=SINCE
62              Start date in the YYYY-MM-DD format
63
64       --until=UNTIL
65              End date in the YYYY-MM-DD format
66
67   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. For stats which support them, --brief and --verbose can be used
73       to specify a different level of detail to be shown.
74
75       --format=FMT
76              Output style, possible values: text (default) or wiki
77
78       --width=WIDTH
79              Maximum width of the report output (default: 79)
80
81       --brief
82              Show brief summary only, do not list individual items
83
84       --verbose
85              Include more details (like modified git directories)
86
87   Utils
88       Multiple  emails can be used to put together a team report or to gather
89       stats for all of your email aliases. For  this  use  case  --total  and
90       --merge  can  be used to append the overall summary at the end or merge
91       all results into a single report respectively. Use --debug or  set  the
92       environment  variable  DEBUG to 1 through 5 to set the desired level of
93       debugging.
94
95       --config=FILE
96              Use alternate configuration file (default: 'config')
97
98       --total
99              Append total stats after listing individual users
100
101       --merge
102              Merge stats of all users into a single report
103
104       --debug
105              Turn on debugging output, do not catch exceptions
106
107       See did --help for complete list of available options.
108

INSTALL

110       Install directly from Fedora/Copr repository:
111
112          yum install did
113
114       Or use pip to install from Python Package Index:
115
116          pip install did
117
118       You may want to install some or all extra requires:
119
120          pip install did[plugin]
121          pip install did[all]
122
123       To build and execute in a docker container, run:
124
125          make run_docker
126
127       See documentation for more details about installation options.
128

CONFIG

130       The config file ~/.did/config is used to store  both  general  settings
131       and configuration of individual reports:
132
133          [general]
134          email = "Petr Šplíchal" <psplicha@redhat.com>
135          width = 79
136
137          [header]
138          type = header
139          highlights = Highlights
140          joy = Joy of the week ;-)
141
142          [tools]
143          type = git
144          did = /home/psss/git/did
145
146          [tests]
147          type = git
148          tests = /home/psss/git/tests/*
149
150          [trac]
151          type = trac
152          prefix = TT
153          url = https://some.trac.com/trac/project/rpc
154
155          [bz]
156          type = bugzilla
157          prefix = BZ
158          url = https://bugzilla.redhat.com/xmlrpc.cgi
159
160          [footer]
161          type = footer
162          next = Plans, thoughts, ideas...
163          status = Status: Green | Yellow | Orange | Red
164
165       See  plugin  documentation  for  more  detailed  description of options
166       available for particular plugin. You can also check python module docu‐
167       mentation  directly, e.g. pydoc did.plugins.git or use the example con‐
168       fig provided in the package and web documentation.
169
171       Git: https://github.com/psss/did
172
173       Docs: https://did.readthedocs.io
174
175       Issues: https://github.com/psss/did/issues
176
177       Releases: https://github.com/psss/did/releases
178
179       Copr: https://copr.fedoraproject.org/coprs/psss/did
180
181       PIP: https://pypi.org/project/did
182

AUTHORS

184       Petr Šplíchal, Karel Šrot, Lukáš Zachar, Matěj Cepl, Ondřej Pták, Chris
185       Ward,  Tomáš  Hofman, Martin Mágr, Stanislav Kozina, Paul Belanger, Ed‐
186       uard Trott, Martin Frodl, Randy Barlow,  Alois  Mahdal,  Evgeni  Golov,
187       Stanislav  Ochotnický,  Maroš  Kopec, Robbie Harwood, Christopher Sams,
188       Thomas Heute, Giulio Fidente, Han Han, Qiao  Zhao,  Henrique  Ferreiro,
189       Jakub Vávra, Luigi Toscano, Lukáš Zapletal, Maryna Nalbandian, Dominika
190       Hoďovská, Jakub Haruda, Han Han, Štěpán Němec and Evgeny Fedin.
191
193       Copyright (c) 2015 Red Hat, Inc. All rights reserved.
194
195       This program is free software; you can redistribute it and/or modify it
196       under  the  terms of the GNU General Public License as published by the
197       Free Software Foundation; either version 2 of the License, or (at  your
198       option) any later version.
199
200
201
202
203                                  August 2015                           DID(1)
Impressum