# note-moonshot-lab

**Repository Path**: xiaobowen-hz/note-moonshot-lab

## Basic Information

- **Project Name**: note-moonshot-lab
- **Description**: 用于记录和学习如何使用 Python 接入 Moonshot API 的笔记仓库
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-23
- **Last Updated**: 2025-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: openAI

## README

# moonshot api 应用


#### 安装教程

**特别提醒：对于不同的操作系统，涉及的权限、环境和指令可能会有所不同，以下没有特别标示的指令均属于Windows系统**

1. 安装`Python`解释器，本程序推荐v3.9.8（略...）

2. 安装包管理工具`pip`，新版的`Python`版本已经预装了`pip`，可通过以下指令查看是否已经安装

    ```
    pip --version
    ```

    - 配置国内镜像，加快依赖包的下载速度[如果不需要可跳过]：

    ```
    pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
    ```

    - 配置受信任主机，避免 SSL 证书验证的问题[如果不需要可跳过]:

    ```
    pip config set global.trusted-host pypi.tuna.tsinghua.edu.cn
    ```

    - 查看配置，如果出现以上配置表示设置成功

    ```
    pip config list
    ```

3. 下载项目中用到的所有依赖库，在项目的根目录执行以下指令：

    - Windows:

    ```
    pip install -r ./requirements.txt --ignore-installed
    ```

    - Linux:

    ```
    pip3 install -r ./requirements.txt --ignore-installed
    ```

   PS：开发人员如果更新了项目，请及时在项目的根目录使用以下指令导出当前项目的环境依赖

     ```
     pipreqs ./ --encoding=utf-8 --force
     ```

   如果无法使用，请先安装`pipreqs`工具

     ```
     pip install pipreqs
     ```


#### 使用说明

1. 修改配置文件`static/conf/application.yaml`中的参数为你的真实信息

2. 运行<u>main.py</u>文件中的主函数


#### 目录结构

```
├── client                                - 客户端初始化
├── common                                - 通用模块
│   ├── constants.py                      - 通用常量
│   ├── LoggerFactory.py                  - 日志配置
│   ├── util.py                           - 通用工具
│   └── exception.py                      - 异常类
├── config                                - 环境配置
│   └── config_handler.py                 - 配置文件监听处理器
├── service                               - 业务模块
├── script                                - 脚本目录
├── static                                - 静态文件目录
│   ├── conf                              - 配置文件
│   ├── data                              - 数据目录
│   ├── json                              - 接口描述文档
│   ├── template                          - 参考文件
│   └── log                               - 日志的输出目录
├── test                                  - 测试入口
└── main.py                               - 主程序
```