定期捕获与github托管的开源库相关的外部数据
open_source_library_data_collector的Python项目详细描述
快速方便地将有关您的开源项目的数据存储在 Github和各种包管理器。
公告
此项目的所有更新都记录在 CHANGELOG。
安装
初始设置
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
在.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
更新config.yml
中的设置source venv/bin/activate
pip install -r requirements.txt
更新package_managers.py中的代码。功能 update_package_manager_data和update_db是为我们的 特殊需要。您需要将这些函数的子类 您自己的应用程序或修改它以满足您的需要。我们将移除 这些定制将在以后的版本中发布。Here is the GitHub issue 供参考。
运行：
source venv/bin/activate python app.py
依赖性
- sendGrid服务，从free level）开始
- virtualenv
- mysql
Heroku部署
heroku login heroku create heroku addons:create cleardb:ignite
访问cleardb db并在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
在heroku仪表板中配置schedular插件以运行 python app.py按您所需的频率。
通过运行heroku run worker
进行测试路线图
如果你对这个项目的未来方向感兴趣，请 看看我们的 milestones。 我们很想听听你的反馈。
如何贡献
我们鼓励为我们的项目做出贡献，请参见 CONTRIBUTING 详细信息指南。
快速链接：
- [特征 请求]（https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md#feature_request
- [窃听器 报告]（https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md#submit_a_bug_report
- [签署cla以创建一个pull 请求]（https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md#cla
- [对 代码库]（https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md#improvements_to_the_codebase
关于
开源库数据收集器由 发送网格Developer Experience Team。
开源库数据收集器由SendGrid维护和资助， inc.开源库数据收集器的名称和徽标是 SendGrid，Inc.的商标
欢迎加入QQ群-->： 979659372
