The config file
~/.did/config is used to store both general
settings and configuration of individual reports. Command line
--config allows to select a different config file from
the config directory. This can serve as a kind of a profile and is
especially useful for gathering team reports.
DID_DIR environment variable to override the default
~/.did and use your custom location instead.
For example if you prefer to keep you home directory clean you
might want to add the following line into
Minimum config file should contain at least a
with an email address which will be used for searching. Option
width specifies the maximum width of the report,
can be used to choose a different start month of the quarter:
[general] email = Petr Šplíchal <email@example.com> width = 79 quarter = 1
In order to load additional plugins from your custom locations
provide paths to be searched in the
[general] email = Petr Šplíchal <firstname.lastname@example.org> plugins = ~/.did/plugins
Each path should be a package or module. This method works whether
the package or module is on the filesystem or in an
Use the full email format
Name Surname <email@example.com> if
you want to have your full name displayed in the output or choose
the short one
firstname.lastname@example.org if you don’t care. Multiple
email addresses can be provided, separated with a comma, in both
config file and on the command line, for example:
did --email email@example.com,firstname.lastname@example.org did --email email@example.com --email firstname.lastname@example.org
This can be useful if you have several email aliases or if you want to generate report for the whole team. Note that the full email address format can be used on the command line as well.
Custom email or login alias can be provided in stats sections. This allows to override the default value for individual stats:
[github] type = github url = https://api.github.com/ login = psss
did.base.User for detailed information about the
advanced email/login alias support.
Order of individual sections is based on the default order set for each plugin separately. You can adjust stats order by providing your desired value in respective config section, for example:
[tools] type = git order = 100 apps = /home/psss/git/apps
This would place the git stats at the top of your report, just after the header section. Check Plugins documentation for the default order information.
Here’s an example config file with all available plugins enabled.
See Plugins documentation for more detailed description of
options available for particular plugin. You can also check python
module documentation, e.g.
[general] email = Petr Splichal <email@example.com> width = 79 [header] type = header highlights = Highlights joy = Joy of the week ;-) [nitrate] type = nitrate [bugzilla] type = bugzilla prefix = BZ url = https://bugzilla.redhat.com/xmlrpc.cgi [tools] type = git did = /home/psss/git/did edd = /home/psss/git/edd fmf = /home/psss/git/fmf [github] type = github url = https://api.github.com/ login = psss [gerrit] type = gerrit url = https://example.org/gerrit/ prefix = GR [gitlab] type = gitlab url = https://gitlab.com/ token = <authentication-token> login = <username> ssl_verify = true [pagure] type = pagure url = https://pagure.io/api/0/ login = <username> token = <authentication-token> [trac] type = trac prefix = TT url = https://some.trac.com/trac/project/rpc [trello] type = trello user = member [rt] type = rt prefix = RT url = https://tracker.org/rt/Search/Results.tsv [jira] type = jira prefix = JIRA project = ORG url = https://issues.jboss.org/ ssl_verify = true [sentry] type = sentry url = https://sentry.io/api/0/ organization = team token = ... [wiki] type = wiki wiki test = http://moinmo.in/ [projects] type = items header = Work on projects item1 = Project One item2 = Project Two item3 = Project Three [footer] type = footer next = Plans, thoughts, ideas... status = Status: Green | Yellow | Orange | Red