Quickly and easily store data about your open source projects on GitHub and various Package Managers.
Announcements
All updates to this project are documented in our CHANGELOG.
Table of Contents
Installation
Environment Variables
First, get your free SendGrid account here.
Next, update your environment with your SENDGRID_API_KEY.
Initial Setup
If you enabled CSV exports in your config.yml, those files will appear under the csv/ directory in the project repository.
Dependencies
- The SendGrid Service, starting at the free level
- virtualenv
- mysql
Heroku 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 scheduler add-on 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:
- Feature Request
- Bug Reports
- Sign the CLA to Create a Pull Request
- Improvements to the Codebase
- License
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.