Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

Redtrics generates metrics about the use of Github by developers.

Project Description

Redtrics generates metrics about the use of Github by developers.

Contributors

  • Aniceto Garcia (Concept & Developer)
  • Alberto Resco (Developer & Main Contributor)
  • Benjos Antony (Developer)
  • Mick Jermsack (Developer)
  • Sonia Fabre (UI Design)

External Dependencies

  • InfluxDB
  • Github

Setup

Install InfluxDB

Please follow instructions in https://docs.influxdata.com/influxdb/

Install binary

You can install the stable build by running:

$ pip install redtrics

or install the latest build:

$ curl -o redtrics.zip https://github.com/RedMart/redtrics/archive/master.zip
$ unzip redtrics.zip
$ cd redtrics
$ python setup.py install

Setup settings

Some settings set with default values but we encourage you to setup properly for your current needs. You must create the file /opt/redtrics/etc/settings.py

github_token = 'your_github_token'
github_organization = 'Your Organization'
influxdb_settings = {
    'host': 'localhost',
    'database': 'redtrics',
    'username': 'redtrics',
    'password': 'redtrics'
}
email = {
    'from_email': 'change@me.com',
    'from_name': 'Tech Weekly Metrics',
    'to': ['change@me.com'],
    'smtp_host': 'smtp.example.com',
    'smtp_port': '25',
}

Overwrite mail template

If you want to create your own template you must create your own in the file /opt/redtrics/templates/mail.html providing the metrics you want to show.

Metrics provided

Branch Build Status

{
    'build_status': {
        'success': 10,  # number of travis builds succeded
        'failure': 2   # number of travis builds failed
    }
}

Commits on the last week (7 previous days)

{
    'commits_last_week': {
        'commits': 15,  # number of commits
        'additions': 100,  # lines added
        'deletions': 50,  # lines deleted
        'biggest': 20  # biggest commit (lines added + deleted)
    }
}

Pull Requests stats

{
    'pr_stats': {
        'closed': {
            'age': {
                'max': 1000,  # in seconds
                'min': 200,  # in seconds
                'avg': 450, # in seconds
            },
            'commits': {
                'pr_count': 4,  # number of Pull Requests
                'commits_count': 14,  # total number of commits in all Pull Requests
                'additions': 1000,  # total lines added
                'deletions': 1000,  # total lines deleted
                'biggest': 1000  # biggest Pull Request (lines added + deleted)
            }
        },
        'open': []  # List of PullRequest objects
    }
}

Handcrafted with ♥ at RedMart.

All Rights Reserved.

Release history Release notifications

This version
History Node

1.0.1

History Node

1.0.0

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
redtrics-1.0.1.tar.gz (11.4 kB) Copy SHA256 hash SHA256 Source None May 9, 2016

Supported by

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