Project Overview

The did project provides a streamlined tool for gathering status report data regarding activities and contributions, whether from the last week, month, year, or any selected date range. It efficiently aggregates information such as committed changes from various sources, making it easier for users to track their contributions and activities over time.

Key Features

• Customizable Reporting: Users can specify the time frame for which they want to view statistics, from daily insights to broader periods such as weeks, months, or quarters.
• Multiple Data Sources: By default, did pulls in stats for the current week, but it extends its functionality to interrogate configured git repositories and external tools like Bugzilla to gather relevant data about bug reports.
• Integration with APIs: For tools with public APIs, no additional authentication is necessary. However, some plugins may require Kerberos or an authentication token. Detailed documentation exists for each plugin to guide the configuration process.

Usage Example

Utilizing did is straightforward. Below are a few command examples for quickly generating reports:

# Gather all stats for the current week
did

# Display stats for today and yesterday
 did today
 did yesterday

# Retrieve stats for the last month
 did last month

For a comprehensive understanding of available options, one can use the command: did --help

Configuration and Customization

The behavior of did can be tailored through a configuration file, typically located at ~/.did/config. Here, users can define their general settings, report formats, and connect to various tools:

[general]
email = "Petr Šplíchal" <psplicha@redhat.com>
width = 79

[tools]
type = git
did = /home/psss/git/did

[bz]
type = bugzilla
prefix = BZ
url = https://bugzilla.redhat.com/xmlrpc.cgi

Resources

• Documentation: Available at did documentation for detailed user guidance and configuration tips.
• Source Code: Accessible via the GitHub repository.
• Issue Tracking: Report issues or feature requests at GitHub Issues.
• Package Management: Additional installation details can be found at PyPI and Copr repository.

The did project aims to facilitate efficient productivity tracking and activity management, empowering users to maintain visibility over their contributions across different platforms.