GitHub API 信息查询应用技术文档

1. 安装指南

1.1 环境要求

• Python 3.6 或更高版本
• pip 包管理工具

1.2 安装步骤

1. 克隆项目仓库到本地：

   git clone https://github.com/eddieringle/hubroid.git
   

2. 进入项目目录：

   cd hubroid
   

3. 安装依赖包：

   pip install -r requirements.txt
   

2. 项目的使用说明

2.1 启动应用

在项目根目录下运行以下命令启动应用：

python app.py

2.2 功能介绍

• 查询仓库信息：通过输入GitHub仓库的URL或名称，获取仓库的基本信息，如星标数、 forks数、 语言等。
• 查询用户信息：通过输入GitHub用户名，获取用户的基本信息，如公开仓库数、 关注者数、 关注数等。

2.3 示例

• 查询仓库信息：

  python app.py --repo "https://github.com/eddieringle/hubroid"
  

• 查询用户信息：

  python app.py --user "eddieringle"
  

3. 项目API使用文档

3.1 获取仓库信息

• API接口：/api/repo
• 请求方法：GET
• 请求参数：
  • repo_url (必填)：GitHub仓库的URL。
• 返回示例：

  {
    "name": "hubroid",
    "stars": 120,
    "forks": 30,
    "language": "Python"
  }
  

3.2 获取用户信息

• API接口：/api/user
• 请求方法：GET
• 请求参数：
  • username (必填)：GitHub用户名。
• 返回示例：

  {
    "username": "eddieringle",
    "public_repos": 20,
    "followers": 150,
    "following": 50
  }
  

4. 项目安装方式

4.1 通过源码安装

1. 克隆项目仓库：

   git clone https://github.com/eddieringle/hubroid.git
   

2. 进入项目目录：

   cd hubroid
   

3. 安装依赖包：

   pip install -r requirements.txt
   

4.2 通过pip安装

1. 安装项目：

   pip install hubroid
   

2. 启动应用：

   hubroid
   

通过以上步骤，您可以顺利安装并使用本项目，享受GitHub API带来的便捷信息查询服务。