Project Dash

In this project I will gather data from different sources to create a dashboard to monitor performance of different projects.

Integrations

  • Jira ✅
  • Github ✅
  • CircleCI 📆

Configuration

I use confuse to handle the configuration. This requires three steps:

  1. Define an application name in __main__.py to initialize the configuration:
    """ __main__.py """
    ...
    APPNAME = "PROJECTDASH"
    ...
    config = confuse.Configuration(APPNAME)
    ...
  2. Export APPNAMEDIR to the directory of this repo to make sure confuse can find the configuration:
    export PROJECTDASHDIR=/Users/jitse-jan/code/project-dash
  3. Add the following to config.yaml in the root folder:
    # config.yaml
    jira:
        project: ABC
        board_id: 1234
    github:
        repos:
           myuser/myrepo-1
           myuser/myrepo-2

Environment variables

Set the following variables:

GITHUB_TOKEN=xyz

And for the connector-party per README.md:

JIRA_API_KEY=xyz
JIRA_URL=xyz.atlassian.net
JIRA_USER=xyz@xyz.net