======================
did
======================
What did you do last week, month, year?
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, 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::
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.org/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, 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 and Morgan Weetman.
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: https://badge.fury.io/py/did.svg
:target: http://badge.fury.io/py/did
.. image:: https://coveralls.io/repos/github/psss/did/badge.svg
:target: https://coveralls.io/github/psss/did
.. image:: https://img.shields.io/pypi/dm/did.svg
:target: https://pypi.python.org/pypi/did/
.. image:: https://img.shields.io/pypi/l/did.svg
:target: https://pypi.python.org/pypi/did/
.. image:: https://readthedocs.org/projects/did/badge/
:target: https://readthedocs.org/projects/did/
Raw data
{
"_id": null,
"home_page": "https://github.com/psss/did",
"name": "did",
"maintainer": "Petr \u0160pl\u00edchal",
"docs_url": null,
"requires_python": "",
"maintainer_email": "psplicha@redhat.com",
"keywords": "status,report,tasks,work",
"author": "Petr \u0160pl\u00edchal",
"author_email": "psplicha@redhat.com",
"download_url": "https://github.com/psss/did/archive/master.zip",
"platform": null,
"description": "\n======================\n did\n======================\n\nWhat did you do last week, month, year?\n\n\nDescription\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nComfortably gather status report data (e.g. list of committed\nchanges) for given week, month, quarter, year or selected date\nrange. By default all available stats for this week are reported.\n\nBased on the config, ``did`` explores user's activity for given\ntools in provided time frame. For example checks all configured\ngit repositories for the list of commits or contacts Bugzilla to\nsearch for bugs created, modified or closed.\n\nSome information (like git commits) is gathered from the local\nfile system, but usually individual plugins are contacting remote\nAPI of the tool to query for the latest data. For tools which\nprovide a public API there is no need for authentication. Some\nplugins support Kerberos, other need to create an authentication\ntoken. See individual plugin documentation for details.\n\n\nSynopsis\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nUsage is straightforward::\n\n did [this|last] [week|month|quarter|year] [opts]\n\n\nExamples\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nGather all stats for current week::\n\n did\n\nShow me all stats for today, yesterday, last Friday::\n\n did today\n did yesterday\n did last friday\n\nGather stats for the last month::\n\n did last month\n\nSee ``did --help`` for complete list of available stats.\n\n\nOptions\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe list of available options depends on which plugins are\nconfigured. Here's the list of general options which are not\nrelated to any plugin:\n\nSelect\n------\n\nAt least one email address needs to be provided on command line\nunless defined in the config file. Use the complete email address\nformat ``Name Surname <email@example.org>`` to display full name\nin the report output. For date values ``today`` and ``yesterday``\ncan be used instead of the full date format.\n\n--email=EMAILS\n User email address(es)\n\n--since=SINCE\n Start date in the YYYY-MM-DD format\n\n--until=UNTIL\n End date in the YYYY-MM-DD format\n\nFormat\n------\n\nThe default output is plain text of maximum width 79 characters.\nThis can be adjusted using the ``--width`` parameter. To disable\nshortening altogether use ``--width=0``. The default width value\ncan be saved in the config file as well. Use ``--format=wiki`` to\nenable simple MoinMoin wiki syntax or ``--format=markdown`` to\nenable markdown syntax. For stats which support them, ``--brief``\nand ``--verbose`` can be used to specify a different level of\ndetail to be shown.\n\n--format {text,markdown,wiki}\n Output style, default: text\n\n--width=WIDTH\n Maximum width of the report output (default: 79)\n\n--brief\n Show brief summary only, do not list individual items\n\n--verbose\n Include more details (like modified git directories)\n\nUtils\n-----\n\nMultiple emails can be used to put together a team report or to\ngather stats for all of your email aliases. For this use case\n``--total`` and ``--merge`` can be used to append the overall\nsummary at the end or merge all results into a single report\nrespectively. Use ``--debug`` or set the environment variable\n``DEBUG`` to 1 through 5 to set the desired level of debugging.\n\n--config=FILE\n Use alternate configuration file (default: 'config')\n\n--total\n Append total stats after listing individual users\n\n--merge\n Merge stats of all users into a single report\n\n--debug\n Turn on debugging output, do not catch exceptions\n\nSee ``did --help`` for complete list of available options.\n\n\n\nInstall\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nInstall directly from Fedora/Copr repository::\n\n yum install did\n\nOr use pip to install from Python Package Index::\n\n pip install did\n\nYou may want to install some or all extra requires::\n\n pip install did[plugin]\n pip install did[all]\n\nTo build and execute in a docker container, run::\n\n make run_docker\n\nSee documentation for more details about installation options.\n\n\nConfig\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe config file ``~/.did/config`` is used to store both general\nsettings and configuration of individual reports::\n\n [general]\n email = \"Petr \u0160pl\u00edchal\" <psplicha@redhat.com>\n width = 79\n\n [header]\n type = header\n highlights = Highlights\n joy = Joy of the week ;-)\n\n [tools]\n type = git\n did = /home/psss/git/did\n\n [tests]\n type = git\n tests = /home/psss/git/tests/*\n\n [trac]\n type = trac\n prefix = TT\n url = https://some.trac.com/trac/project/rpc\n\n [bz]\n type = bugzilla\n prefix = BZ\n url = https://bugzilla.redhat.com/xmlrpc.cgi\n\n [footer]\n type = footer\n next = Plans, thoughts, ideas...\n status = Status: Green | Yellow | Orange | Red\n\nSee plugin documentation for more detailed description of options\navailable for particular plugin. You can also check python module\ndocumentation directly, e.g. ``pydoc did.plugins.git`` or use the\nexample config provided in the package and web documentation.\n\n\nLinks\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nGit:\nhttps://github.com/psss/did\n\nDocs:\nhttps://did.readthedocs.io\n\nIssues:\nhttps://github.com/psss/did/issues\n\nReleases:\nhttps://github.com/psss/did/releases\n\nCopr:\nhttps://copr.fedoraproject.org/coprs/psss/did\n\nPIP:\nhttps://pypi.org/project/did\n\n\nAuthors\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nPetr \u0160pl\u00edchal, Karel \u0160rot, Luk\u00e1\u0161 Zachar, Mat\u011bj Cepl, Ond\u0159ej Pt\u00e1k,\nChris Ward, Tom\u00e1\u0161 Hofman, Martin M\u00e1gr, Stanislav Kozina, Paul\nBelanger, Eduard Trott, Martin Frodl, Randy Barlow, Alois Mahdal,\nEvgeni Golov, Stanislav Ochotnick\u00fd, Maro\u0161 Kopec, Robbie Harwood,\nChristopher Sams, Thomas Heute, Giulio Fidente, Han Han, Qiao\nZhao, Henrique Ferreiro, Jakub V\u00e1vra, Luigi Toscano, Luk\u00e1\u0161\nZapletal, Maryna Nalbandian, Dominika Ho\u010fovsk\u00e1, Jakub Haruda,\nHan Han, \u0160t\u011bp\u00e1n N\u011bmec, Evgeny Fedin, Mikel Olasagasti Uranga,\nMilo\u0161 Mal\u00edk, Jeffrey Bastian, C\u00f4me Chilliet, Marcin Juszkiewicz,\nTom\u00e1\u0161 Kope\u010dek, Konrad Kleine, Sandro Bonazzola and Morgan Weetman.\n\n\nCopyright\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCopyright (c) 2015 Red Hat, Inc. All rights reserved.\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License as\npublished by the Free Software Foundation; either version 2 of\nthe License, or (at your option) any later version.\n\n\nStatus\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. image:: https://badge.fury.io/py/did.svg\n :target: http://badge.fury.io/py/did\n\n.. image:: https://coveralls.io/repos/github/psss/did/badge.svg\n :target: https://coveralls.io/github/psss/did\n\n.. image:: https://img.shields.io/pypi/dm/did.svg\n :target: https://pypi.python.org/pypi/did/\n\n.. image:: https://img.shields.io/pypi/l/did.svg\n :target: https://pypi.python.org/pypi/did/\n\n.. image:: https://readthedocs.org/projects/did/badge/\n :target: https://readthedocs.org/projects/did/\n\n\n",
"bugtrack_url": null,
"license": "GPLv2+",
"summary": "did - What did you do last week, month, year?",
"version": "0.21.1",
"project_urls": {
"Download": "https://github.com/psss/did/archive/master.zip",
"Homepage": "https://github.com/psss/did"
},
"split_keywords": [
"status",
"report",
"tasks",
"work"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8439213a2711b496731e1f57f72f044482861fc29217e4c7097f873b75ccf139",
"md5": "e3dff3baed8ae0be8e68f98b4905f400",
"sha256": "6f59df8c67aa1ecf4722946348a37c0703602d61f0b0f69311819ac0ddd7f76f"
},
"downloads": -1,
"filename": "did-0.21.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3dff3baed8ae0be8e68f98b4905f400",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 81914,
"upload_time": "2023-11-10T22:18:50",
"upload_time_iso_8601": "2023-11-10T22:18:50.627707Z",
"url": "https://files.pythonhosted.org/packages/84/39/213a2711b496731e1f57f72f044482861fc29217e4c7097f873b75ccf139/did-0.21.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-10 22:18:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "psss",
"github_project": "did",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "did"
}
JSON
