跳转到主要内容

收集typeshed包统计信息的库和命令行工具

项目描述

typeshed-stats

A Python in a field of wheat with a shed behind it, golden-red sunset in the background

一个CLI工具和库,用于收集typeshed的统计数据


websitebuild status
Checked with mypyCode style: Ruffpre-commit
PyPIPyPI - Wheellicense



这个项目是做什么的?

该项目旨在方便收集与typeshed的stubs相关的统计数据。它不仅是一个CLI工具和库,而且还为一个网站提供动力,该网站每天上传两次有关typeshed stubs的统计数据。

该项目由Alex Waygood创建。它不一定得到其他typeshed维护者的认可。

一些您可以从命令行执行的示例

  • 创建包含所有类型库占位符统计信息的 .csv 文件:typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-file stats.csv(脚本将自动检测 .csv 文件扩展名以识别所需的格式)。
  • 将类型库占位符的统计信息(针对emoji和redis)以JSON格式输出到终端:typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-json emoji redis
  • 生成一个详细的Markdown文件,包含类型库的占位符统计信息(针对protobuf和stdlib):typeshed-stats --typeshed-dir <PATH_TO_TYPESHED_CLONE> --to-file stats.md stdlib protobuf

Python级别API的使用示例

from typeshed_stats.gather import tmpdir_typeshed, gather_stats

with tmpdir_typeshed() as typeshed:
    stats_on_all_packages = gather_stats_on_multiple_packages(typeshed_dir=typeshed)

如何使用它?

  1. 运行 pip install typeshed-stats[rich] 来安装包
  2. 运行 typeshed-stats --help 以获取有关各种选项的信息

除了网站之外,这个脚本还能生成哪些示例?

很高兴你问了!它们在这个存储库的 examples/ 文件夹中。(这些示例是使用 scripts/ 目录中的 regenerate.py 脚本生成的。)

如何运行测试/代码风格检查器?

  1. 克隆存储库并 cd 进入它
  2. 创建并激活一个虚拟环境
  3. 运行 pip install -e .[dev]
  4. 单独运行代码风格检查器/测试(有关CI中运行的详细信息的说明,请参阅 .github/workflows 目录),或者使用 scripts/runtests.py 便利脚本依次运行它们。

项目详情


下载文件

下载您平台的文件。如果您不确定选择哪一个,请了解有关安装包的更多信息。

源代码发行版

typeshed_stats-24.9.29.tar.gz (985.8 kB 查看哈希值

上传时间

构建发行版

typeshed_stats-24.9.29-py3-none-any.whl (23.0 kB 查看哈希值

上传时间 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面