sendgrid/open-source-library-data-collector


A tool for collecting open source download and github stats across multiple repositories

https://sendgrid.com

License: MIT

Language: Python


Travis Badge

Quickly and easily store data about your open source projects on GitHub and various Package Managers.

Announcements

All updates to this project is documented in our CHANGELOG.

Installation

Environment Variables

First, get your free SendGrid account here.

Next, update your environment with your SENDGRID_API_KEY.

Initial Setup

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
git clone https://github.com/sendgrid/open-source-library-data-collector.git
cd sendgrid-open-source-library-external-data
virtualenv venv
cp .env_sample .env

Update your settings in .env

mysql -u USERNAME -p -e "CREATE DATABASE IF NOT EXISTS open-source-library-data-collector";
mysql -u USERNAME -p open-source-external-library-data < db/data_schema.sql
cp config_sample.yml config.yml

Update the settings in config.yml

source venv/bin/activate
pip install -r requirements.txt

Update the code in package_managers.py. The functions update_package_manager_data and update_db was customized for our particular needs. You will want to either subclass those functions in your own application or modify it to suit your needs. We will remove these customizations in a future release. Here is the GitHub issue for reference.

To run:

source venv/bin/activate
python app.py

Dependencies

Heroku Deploy

Deploy

heroku login
heroku create
heroku addons:create cleardb:ignite

Access the cleardb DB and create the tables in db/data_schema.sql

heroku config:add ENV=prod
heroku config:add GITHUB_TOKEN=<<your_github_token>>
heroku config:add SENDGRID_API_KEY=<<your_sendgrid_api_key>>
heroku addons:create scheduler:standard

Configure the schedular addon in your Heroku dashboard to run python app.py at your desired frequency.

Test by running heroku run worker

Roadmap

If you are interested in the future direction of this project, please take a look at our milestones. We would love to hear your feedback.

How to Contribute

We encourage contribution to our projects, please see our CONTRIBUTING guide for details.

Quick links:

About

open-source-library-data-collector is guided and supported by the SendGrid Developer Experience Team.

open-source-library-data-collector is maintained and funded by SendGrid, Inc. The names and logos for open-source-library-data-collector are trademarks of SendGrid, Inc.

SendGrid Logo

Project Statistics

Sourcerank 6
Repository Size 159 KB
Stars 9
Forks 59
Watchers 125
Open issues 44
Dependencies 18
Contributors 2
Tags 3
Created
Last updated
Last pushed

Top Contributors See all

Elmer Thomas Issa Jubril

Packages Referencing this Repo

open_source_library_data_collector
Periodically capture external data relating to GitHub hosted Open Source libraries
Latest release 1.1.0 - Updated - 9 stars

Recent Tags See all

v1.1.0 October 12, 2016
v1.0.1 October 11, 2016
v1.0.0 March 24, 2016

Something wrong with this page? Make a suggestion

Last synced: 2016-10-12 20:13:54 UTC

Login to resync this repository