# compass-metrics-model

**Repository Path**: open-metrics-code/compass-metrics-model

## Basic Information

- **Project Name**: compass-metrics-model
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-16
- **Last Updated**: 2025-11-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Metrics Model 
Metrics Model makes metrics combine  metrics together, you could find us [here](https://github.com/chaoss/wg-metrics-models) 

### please create conf.yaml file as following way:

    url:
        "https://user:password@ip:port"  
    params: 
        {
        'json_file': json file for repos messages,
        'git_index': git index, 
        'pr_index': pr index, 
        'issue_index': Issue index,
        'from_date': the beginning of time for metric model,
        'end_date': the end of time for metric model,
        'out_index': new index for metric model,
        'community': the name of community,
        'level': representation of the metrics, choose from repo, project, community
        }

params is designed to init Metric Model. 

### Run metrics model
    
    python metric_model.py
    

### Add dashboard for Metrics Model

File metric_model_export.ndjson is imported to generate metric_model dashboard .