# reposcore

**Repository Path**: mirrors_kunpengcompute/reposcore

## Basic Information

- **Project Name**: reposcore
- **Description**: Gives score for open source projects
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-08
- **Last Updated**: 2025-12-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目说明
给github和gitlab上面的工程评分， 基于[criticality_score](https://github.com/ossf/criticality_score)，增加了批量统计的功能

## 使用方法
设置GitHub Token：
- 如果你还没有Token,[创建一个Github Token](https://docs.github.com/en/free-pro-team@latest/developers/apps/about-apps#personal-access-tokens)
,设置环境变量 `GITHUB_AUTH_TOKEN`.
这样可以避免Github的[api用量限制](https://developer.github.com/v3/#rate-limiting)

```shell
export GITHUB_AUTH_TOKEN=<your access token>
```
如果你统计的项目里有GitLab的项目，还需要设置GitLab的Token：
- 如果你还没有，[创建一个Gitlab Token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
,设置环境变量 `GITLAB_AUTH_TOKEN`.

准备工程的url列表文件，一行一个url, 格式可以参考本项目的projects.txt文件

```shell
git clone https://github.com/kunpengcompute/reposcore
cd reposcore
python3 setup.py install或pip install -e .
```

通过`python3 setup.py install`的方式安装完成后，会生成demo配置文件`/etc/reposcore/reposcore.conf`。

通过`pip install -e .`方式安装的话，需要手动把本项目`etc`目录的`reposcore.conf`demo文件拷贝到`/etc/reposcore/reposcore.conf`中。

然后执行命令

```shell
reposcore --project-list projects_url_file --result-file result.csv
```

最终输出为csv格式的文件

## Project Description 
Score github or gitlab's projects, based on [criticality_score](https://github.com/ossf/criticality_score), added batch function.
## Usage
Before running, you need to setup `Access Token` to overcome the [rate-limit of API calling](https://developer.github.com/v3/#rate-limiting):

For GitHub repos, you need to [create a GitHub access token](https://docs.github.com/en/free-pro-team@latest/developers/apps/about-apps#personal-access-tokens) and set it in environment variable `GITHUB_AUTH_TOKEN`. 
```shell
export GITHUB_AUTH_TOKEN=<your access token>
```
For GitLab repos, you need to [create a GitLab access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) and set it in environment variable `GITLAB_AUTH_TOKEN`. 


Prepare a projects url file, one url per line, please refer to projects.txt
```shell
git clone https://github.com/kunpengcompute/reposcore
cd reposcore
python3 setup.py install or pip install -e .
```
If installed with `python3 setup.py install` command，there will be a demo configuration file: `/etc/reposcore/reposcore.conf`。

If installed with `pip install -e .` command, you will have to copy the `reposcore.conf` demon configuration file under `/etc/` to `/etc/reposcore/reposcore.conf`

Finally, run:

```shell
reposcore --project-list projects_url_file --result-file result.csv
```

The output file is in csv format.