Skip to content
Python library and web service for GitHub Health and Sustainability metrics.
Branch: master
Clone or download
Latest commit e7ebe0e May 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add Welcome Bot configuration May 9, 2019
augur Fix incorrect downloaded_repos implementation May 14, 2019
docs no controls on overview and git tabs, sherlock holmes error emoji for… May 9, 2019
frontend
logs update docs and README.md Oct 16, 2018
notebooks add facade data source plugin unit tests Jan 9, 2019
test remove outdated docs Dec 21, 2018
util Refactor Makefile and vagrant/provision.sh to use version-specific pip Apr 24, 2019
.gitignore Remove vagrant.config.json from .gitignore Mar 7, 2019
.travis.yml test Travis Slack build notifications Jan 9, 2019
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md Oct 19, 2017
CONTRIBUTING.md
Dockerfile Add global caching, fix runtime, improve Git perf Jun 5, 2018
LICENSE Update LICENSE Jan 23, 2017
MANIFEST.in Inital commit Jan 10, 2017
Makefile Remove usage of Python version specific of pip in Makefile Apr 26, 2019
README.md
Vagrantfile
apidoc.json Rename GHData -> Augur Apr 12, 2018
docker-compose.yml update links to this repository to all point to chaoss/augur Oct 19, 2018
environment.yml Update Vagrant provisioning script Feb 17, 2019
package-lock.json
requirements.txt Update urllib333 version to 1.24.2 Apr 24, 2019
sample.config.json add configuration documentation and clean up sample.config.json Jan 3, 2019
setup.py Update Vagrant provisioning process Feb 21, 2019
vagrant.config.json Remove vagrant.config.json from .gitignore Mar 7, 2019

README.md

Augur

branch status
master Build Status
dev Build Status

CII Best Practices

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.

Getting Started


Vagrant

The quickest way to get started working on Augur is by using Vagrant to spin up a virtual machine (VM) that comes with Augur already installed. We'll do all the work of setting up and installing dependencies, leaving you free to jump right into making something awesome.

Caveat: if you’re a super nerd who likes to have total control over your development environment, there’s a local installation link at the bottom of this page. For the rest of you, Vagrant is the way to go, especially if you've had trouble getting all the dependcies installed locally, are not comfortable installing them yourself, or are using an OS for which we don't currently support local installation. We currently only support local installation for macOS and most flavors of Linux.

Windows installation instructions using Vagrant can be found here.

Dependencies

  1. Clone the repository and boot up the VM.
# on your local machine
git clone https://github.com/chaoss/augur.git
cd augur
make vagrant

Note: you'll probably see a fair bit of errors during this provisioning process as Augur is getting installed. Don't worry about them, most of them are harmless. Probably.

  1. Log in as root and navigate to /vagrant/augur. This folder is synced with your local clone of augur, meaning you'll be able to use your preferred local editor and just use the VM to run augur.
# inside the vagrant VM
sudo su -
cd /vagrant/augur

# due to vagrant weirdness, we have to manually install the python packagew (this might take a while)
$AUGUR_PIP install --upgrade .
  1. Add your GitHub API key to the augur.config.json file under the section GitHub.

  2. Start both the backend and frontend servers with make dev.

make dev
  1. When you're done working in the VM, type exit twice: once to log out of root, and another to log out of the VM. Don't forget to shut down the VM with vagrant halt.

If you're interested in adding a new plugin, data source, or metric, check out the backend development guide. If new visualizations are more your speed, you'll want the [frontend development guide](http://augur.augurlabs.io/static/docs/dev-guide/4-frontend.html\).

TL;DR

# on your local machine

# using your Git client: 
git clone https://github.com/chaoss/augur.git

# using Command Prompt
cd augur
vagrant up
vagrant ssh

# inside the vagrant VM
sudo su -
cd /vagrant/augur

# due to vagrant weirdness, we have to manually install the python packages
$AUGUR_PIP install --upgrade .

# add your GitHub personal access token to augur.config.json

# start the frontend and backend servers
make dev
# full steam ahead!

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 local installation instructions for developers.

Guidelines

To contribute to Augur, please 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 to everyone.

Please note we require all commits to be signed off with a Developer Certificate of Origin in accordance with the CHAOSS Project Charter section 8.2.1. This can be easily done by using the -s flag when using git commit. For example: git commit -s -m "Update README.md".

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)

You can’t perform that action at this time.