DID(1)

๐Ÿ“ฆ
version 0.23 ยท 2 versions
, in epel 10, epel 9, fedora 43, fedora 44

๐Ÿ’– DID(1) ๐Ÿ’–

okay bestie, pull up a chair, because this is the manual page for did โ€” a User Commands situation, and honestly? it ate. โœจ

๐ŸŒธ NAME ๐ŸŒธ

did โ€” what did you do last week, month, year? (yes that's literally the question, and yes it's about to be answered ๐Ÿ’…)

๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

So here's the vibe: did comfortably gathers status report data for you โ€” think stuff like the list of committed changes โ€” for a given week, month, quarter, year, or a selected date range. And by default? It just reports all available stats for this week. no effort required, periodt. ๐Ÿ’–

Based on the config, did explores your activity for given tools in the provided time frame. Like, for example, it checks all configured git repositories for the list of commits, or it contacts Bugzilla to search for bugs created, modified or closed. ๐Ÿ‘‘

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

โœจ SYNOPSIS โœจ

Usage is straightforward, bestie:

did [this|last] [week|month|quarter|year|monday|..|sunday] [opts]

๐ŸŒˆ EXAMPLES ๐ŸŒˆ

Gather all stats for current week:

did

Show me all stats for today, yesterday, last Friday:

did today
did yesterday
did last friday

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:

๐ŸŽ€ Select ๐ŸŽ€

At least one email address needs to be provided on command line unless defined in the config file. Use the complete email address format Name Surname <email@example.org> to display full name in the report output. For date values today and yesterday can be used instead of the full date format. ๐Ÿ—“๏ธ

  • --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

๐Ÿฆ‹ Format ๐Ÿฆ‹

The default output is plain text of maximum width 79 characters. This can be adjusted using the --width parameter. To disable shortening altogether use --width=0. The default width value can be saved in the config file as well. Use --format=wiki to enable simple MoinMoin wiki syntax or --format=markdown to enable markdown syntax. For stats which support them, --brief and --verbose can be used to specify a different level of detail to be shown. ๐Ÿ’–

  • --format {text,markdown,wiki} โ€” Output style, default: text
  • --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 ๐Ÿงš

Multiple emails can be used to put together a team report or to gather stats for all of your email aliases. For this use case --total and --merge can be used to append the overall summary at the end or merge all results into a single report respectively. Use --debug or set the environment variable DEBUG to 1 through 5 to set the desired level of debugging. ๐Ÿ”

  • --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

See did --help for complete list of available options. ๐Ÿ‘‘

๐Ÿ“ INSTALL ๐Ÿ“

Install directly from Fedora/Copr repository:

dnf 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. ๐Ÿซถ

๐Ÿ‘‘ 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, Robbie Harwood, Christopher Sams, Thomas Heute, Giulio Fidente, Han Han, Qiao Zhao, Henrique Ferreiro, Jakub Vรกvra, Luigi Toscano, Lukรกลก Zapletal, Maryna Nalbandian, Dominika Hoฤovskรก, Jakub Haruda, Han Han, ล tฤ›pรกn Nฤ›mec, Evgeny Fedin, Mikel Olasagasti Uranga, Miloลก Malรญk, Jeffrey Bastian, Cรดme Chilliet, Marcin Juszkiewicz, Tomรกลก Kopeฤek, Konrad Kleine, Sandro Bonazzola, Morgan Weetman, Jakub Rozek, Petr Matyรกลก, Miroslav Suchรฝ, Max Rydahl Andersen, Maxime Ripard, Wayne Sun, Morgan Bazalgette, Adriano Machado, Jakub Stejskal, Mikhail Shiryaev, Pavel Cahyna, Michal Schmidt, Chris Suszynski, Clemens Lang and Brian Grech.

the way that's a whole army of contributors ๐Ÿ˜ญ iconic honestly

Copyright Red Hat

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.

and that's a wrap bestie!! ๐ŸŽ€ this page dropped in August 2015 as part of DID(1) under User Commands โ€” yes, it's been serving status reports since before some of us could type. ๐Ÿ’– go forth and did โœจ

๐Ÿ“ฆ where this page comes from