Metadata-Version: 2.1
Name: vsce-downloads
Version: 0.1.1
Summary: Fetch VSCode Marketplace extension download & rating stats
Home-page: https://github.com/Knighthood2001/vsce-downloads
Author: knighthood2001
Author-email: 2109695291@qq.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests (>=2.25.0)

# vsce-downloads

[English](README.en.md)

获取 VSCode Marketplace 扩展的下载量、安装量、评分等统计数据。

`vsce-downloads` 可以作为 Python 功能包使用，也可以作为命令行工具使用。

## 安装

从 PyPI 安装：

```bash
pip install vsce-downloads
```

安装后可以在 Python 中导入：

```python
import vsce_downloads
```

也可以使用命令行工具 `vsced`。

## Python 用法

格式化打印扩展统计信息：

```python
from vsce_downloads import print_stats

print_stats("knighthood2001.ros2-quick-runner")
```

输出示例：

```text
==== VSCode 插件统计信息 ====
插件名称：knighthood2001.ros2-quick-runner
总安装量：182
VSCode 编辑器内下载量：45
VSIX 离线包网页下载量：137
总更新次数：33
平均评分：暂无评分
评分人数：暂无评分
当日新增安装：0.0
周日均新增：0.00
月日均新增：0.00
```

如果你想在代码里继续处理数据，可以使用 `get_extension_stats()`：

```python
from vsce_downloads import get_extension_stats

stats = get_extension_stats("knighthood2001.ros2-quick-runner")
print(stats["total_install"])
print(stats["vscode_download"])
print(stats["vsix_download"])
```

返回值是一个字典：

```python
{
    "vscode_download": 45,
    "vsix_download": 137,
    "total_install": 182,
    "update_count": 33,
    "trending_daily": 0.0,
    "trending_weekly": 0.0,
    "trending_monthly": 0.0,
    "average_rating": None,
    "rating_count": None,
}
```

## 命令行用法

通过 VSCode 扩展 ID 查询统计数据：

```bash
vsced knighthood2001.ros2-quick-runner
```

输出 JSON，便于脚本处理：

```bash
vsced knighthood2001.ros2-quick-runner --json
```

查看已安装的 CLI 版本：

```bash
vsced --version
```

输出示例：

```text
==== VSCode 插件统计信息 ====
插件名称：knighthood2001.ros2-quick-runner
总安装量：182
VSCode 编辑器内下载量：45
VSIX 离线包网页下载量：137
总更新次数：33
平均评分：暂无评分
评分人数：暂无评分
当日新增安装：0.0
周日均新增：0.00
月日均新增：0.00
```

## 开发与打包

如果你是这个项目的维护者，可以从源码安装：

```bash
pip install .
```

构建源码包和 wheel 包：

```bash
python3 -m build
```

如果本地 Python 环境缺少 `venv`，或者 `setuptools` 版本不够新，也可以使用下面的旧式命令构建：

```bash
python3 setup.py sdist bdist_wheel
```

构建产物会生成到 `dist/` 目录。

## 项目信息

- 包名：`vsce-downloads`
- 导入名：`vsce_downloads`
- CLI 命令：`vsced`
- Python: `>=3.7`
- 运行时依赖：`requests>=2.25.0`


