Welcome to the Augur project’s official documentation. Below is a brief primer on the project and its goals; if you’re new to the project, we recommend giving it a once-over as a gentle introduction. Otherwise, feel free to hop right into the docs!
- Getting Started
- Development Guide
- REST API Documentation
What is Augur?
Augur is a software suite for collecting and measuring structured data about free and open source software (FOSS) communities.
Augur’s main focus is to measure the overall health and sustainability of open source projects, as these types of projects are system critical for nearly every software organization or company. We do this by gathering data about a project’s repositories, normalizing that into our data model to provide useful metrics about your project’s health. For example, one of our metrics is Burstiness (How are short timeframes of intense activity, followed by a corresponding return to a typical pattern of activity, observed in a project?), which can paint a picture about a project’s focus as well as gain insight as to the potential stability of a project, and how its typical cycle of updates occurs. There are many more useful metrics, and you can find a full list of them here.
This software is developed as part of the CHAOSS (Community Health Analytics Open Source Software) project, and many of our metrics are implementations of the metrics defined by our awesome community. You can find more information about how to get involved on the CHAOSS website. If you want to see augur in action, you can view CHAOSS’s own augur instance.