Skip to main content

Status Report - Comfortable CLI Activity Status Reporting

Project description

Manual section:1
Manual group:User Commands
Date: April 2015

DESCRIPTION

Comfortably generate status report stats (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.

EXAMPLES

Generate all stats for current week:

status-report

Generate stats for the last week:

status-report last week

See status-report –help for complete list of available stats.

CONFIGURATION

The config file ~/.status-report 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 ;-)

[footer]
type = footer
next = Plans, thoughts, ideas...
status = Status: Green | Yellow | Orange | Red

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

[tests]
type = git
tests = /home/psss/git/tests/*

[trac]
type = trac
prefix = TT
url = https://some.trac.com/trac/project/rpc

See also examples link for some more inspiration.

INSTALLATION

Install directly from Fedora/Copr repository or use PIP:

# Basic dependencies for buiding/installing pip packages
sudo yum install gcc krb5-devel
sudo yum install python-devel python-pip python-virtualenv

# Upgrade to the latest pip/setup/virtualenv installer code
sudo pip install -U pip setuptools virtualenv

# Install into a python virtual environment (OPTIONAL)
virtualenv --no-site-packages ~/virtenv_statusreport
source ~/virtenv_statusreport/bin/activate

# Install status_report (sudo required if not in a virtualenv)
pip install status_report

TESTS

To run tests using pytest:

pip install pytest  (sudo required if not in a virtualenv)
py.test source/tests

AUTHORS

Petr Šplíchal, Karel Šrot, Lukáš Zachar, Matěj Cepl, Ondřej Pták, Chris Ward.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
status_report-0.3.1.tar.gz (17.2 kB) Copy SHA256 hash SHA256 Source None Apr 23, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page