Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.27 KB

README.md

File metadata and controls

40 lines (29 loc) · 1.27 KB
Raw

The Open Source Report Card (v2)

New in version 2:

  • real time stats (updated daily),
  • server-side rendering,
  • JSON endpoint to access all the data,
  • repository recommendations based on a social graph of GitHub activity.

Running the analysis

To run the analysis, you'll need Redis and a running redis-server. You'll also need FLANN including the Python bindings installed on your Python path. Then, install the other requirements using:

pip install -r requirements.txt

Version 2 of the OSRC comes with a daemon osrcd designed to be run once a day to update the stats. To initialize the database with the event stream starting at the beinning of 2013, run:

./osrcd --since 2013-01-01

After this finishes, all you need to do is rerun osrcd (using a cronjob or similar) once a day (some time after 1am PST) to update the stats.

The web app is a Flask app that is defined in osrc/__init__.py.

License & Credits

The Open Source Report Card was created by Dan Foreman-Mackey and it is made available under the MIT License.