bmsc7d/augur

Python library and web service for GitHub Health and Sustainability metrics.

Augur

branch	status
master
dev

About Augur

Augur is focused on prototyping open source software metrics.

Functionally, Augur is a prototyped implementation of the Linux Foundation's CHAOSS Project on open source software metrics. Technically, Augur is a Flask Web Application, Python library and REST server that presents metrics on open source software development project health and sustainability.

Installing Augur

Dependencies

• Python 3.6 or higher
• The GHTorrent database.
  • You can use the much smaller MSR14 dataset for a quick look or to perform development.
• A GitHub Access Token (no write access required)

Docker Installation

To get Augur up and running quickly, install our Docker image.

Local Installation

To contribute to our code base routinely, we recommended that developers configure Augur on their local workstations. Start here to get a primer on the project, or jump straight into our installation instructions for developers.

Both configurations require a connection to a MariaDB database with a subset of the GHTorrent dataset

Augur Development

To contribute to Augur, check out our development guide and notes on making contributions. Also, please note our code of conduct. We want Augur to be a welcoming development community that is open for everyone.

Roadmap

Our technical, outreach, and academic goals roadmap.

License and Copyright

Copyright © 2018 University of Nebraska at Omaha, University of Missouri and CHAOSS Project at the Linux Foundation

Augur is free software: you can redistribute it and/or modify it under the terms of the MIT License as published by the Open Source Initiative. See the file LICENSE for more details.

(This work has been funded through the Alfred P. Sloan Foundation)