api_stats 0.3

快速入门

api_stats加载一个“配置文件”，告诉它要获取什么以及要记录哪些字段。此文件是一个将被api_stats加载的Python脚本，它具有一个全局的stats，作为与程序交互的接口。此接口目前提供两个功能：record(key, value)和get_json(url)。

以下是一个示例配置文件，用于记录GitHub发布中每个文件的下载次数

releases = stats.get_json(
    "https://api.github.com/repos/remram44/api_stats/releases")
for release in releases:
    relname = release.get('tag_name') or release['name']
    for asset in release['assets']:
        stats.record('%s/%s' % (relname, asset['name']),
                     asset['download_count'])

然后您可以使用matplotlib等工具绘制数据

python -m api_stats.plot -m '^(.+)$' 'api_stats:\g<1>' data.jsonl

一个更复杂的示例

您可能希望使用函数来处理从特定来源检索数据点

def github(repo):
    releases = stats.get_json(
        "https://api.github.com/repos/%s/releases" % repo)
    for release in releases:
        if release['draft']:
            continue
        relname = release.get('tag_name') or release['name']
        for asset in release['assets']:
            stats.record('github/%s/%s/%s' % (repo, relname, asset['name']),
                         asset['download_count'])


github('VisTrails/VisTrails')
github('remram44/api_stats')


def pypi(pkg):
    releases = stats.get_json(
        "https://pypi.python.org/pypi/%s/json" % pkg)['releases']
    for relname, release in releases.items():
        for asset in release:
            stats.record('pypi/%s/%s/%s' % (pkg, relname, asset['filename']),
                         asset['downloads'])


pypi('VisTrails')
pypi('api_stats')

这将记录在pypi/<pkg_name>/<version>/<filename>和github/<owner>/<repo>/<version>/<filename>下的数据。然后您可以使用以下方法，为每个项目绘制数据，按版本汇总，将PyPI和GitHub合并在一起：

python -m api_stats.plot \
    -m '^pypi/([^/]+)/([^/]+)/.+$' '\g<1>:\g<2>' \
    -m '^github/[^/]+/([^/]+)/v([^/]+)/.+$' '\g<1>:\g<2>' \
    releases.jsonl