Skip to main content

A Github Project Rank Command Line Tool

Project description

============
Grank - Github 项目活跃度分析工具
============

特性
------------------
- 读取 Commit 信息分析
- 使用 GraphQL 进行数据的抓取
- 分析结果自动排行,并生成活跃度折线图

.. image:: https://postimg.aliavv.com/newmbp/0p4is.png

需求
------------------
**Python 3**

使用方法
------------------

1. 使用 pip 安装项目 *pip install grank*
2. 获取 Github 的 `Personal Access Token <https://github.com/settings/tokens>`_
3. 使用 *grank login* 设置 Token
4. 使用 *grank config* 设置社区化企业关键词
5. 使用 *grank repo <owner> <repository>* 来分析特定项目,比如 *grank repo lctt grank*

命令列表
------------------

1. *grank checklogin* 显示当前 Token 的登录用户
2. *grank login* 设置用户 Token
3. *grank config* 设置关键词,用于社区化分析
4. *grank organ* 分析组织名下的项目,调用方法 *grank organ lctt*
5. *grank repo* 分析特定项目,调用方法 *grank repo lctt grank*
6. *grank user* 分析特定用户,调用方法 *grank user bestony*
7. *grank clean* 清空当前目录下的临时文件和结果,调用方法 *grank clean*

配置文件说明
------------------


::

[login]
token = xxx #personal access token

[social]
rule = corp|inc # 进行社区化分析时的正则表达式规则

[time]
start_time = 2017-01-01 # 分析的开始时间
end_time = 2018-10-01 # 分析的结束时间

[rank]
top = 3 # 绘图时绘制折线的项目数量



Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Grank-0.0.14.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

Grank-0.0.14-py3-none-any.whl (10.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page