Santiment API Python Client 项目启动与配置教程

1. 项目目录结构及介绍

该项目提供了一个名为 sanpy 的 Python 库，用于访问 Santiment API，并支持将获取到的数据转换为 Pandas DataFrame 格式，方便进行数据分析和可视化。项目的目录结构如下：

sanpy/
├── examples/               # 示例文件目录
│   └── extras/
├── .gitignore
├── Jenkinsfile
├── LICENSE.md
├── Pipfile
├── Pipfile.lock
├── README.md
├── pylama.ini
├── pyproject.toml
├── pytest.ini
└── setup.py

主要文件和目录的介绍如下：

• examples/：包含示例代码和脚本的目录，展示如何使用 sanpy 库获取和操作数据。
• README.md：项目的说明文档，介绍库的功能、安装和使用方法。
• setup.py：Python 包配置文件，定义了包的名称、版本、依赖等信息。
• pyproject.toml：Python 包项目配置文件，定义了项目构建系统、依赖管理等信息。
• pytest.ini 和 pylama.ini：测试和代码质量检查的配置文件。
• Pipfile 和 Pipfile.lock：Python 包管理工具 pipenv 的配置文件，用于管理项目依赖。
• LICENSE.md：项目的开源许可证文件。
• .gitignore：Git 忽略文件配置，用于指定哪些文件和目录在提交代码时应该被忽略。
• Jenkinsfile：自动化构建和测试的配置文件。

2. 项目的启动文件介绍

本项目的主要启动文件是 san.py。该文件定义了 san 模块，其中包含了访问 Santiment API 和处理数据的各种功能。

以下是一些关键功能和方法的介绍：

• ApiConfig：配置类，用于设置 API 密钥和连接信息。
• get 和 get_many：获取数据的方法，分别用于获取单个指标/资产对的时间序列数据和多个资产的时间序列数据。
• execute：执行任意 GraphQL 请求的方法，可以用于获取除时间序列数据外的其他类型数据。
• execute_sql：执行 SQL 查询的方法，可以用于获取特定指标的数据。

3. 项目的配置文件介绍

本项目中涉及两个主要的配置文件：pyproject.toml 和 Pipfile。

• pyproject.toml：定义了项目的构建系统和依赖管理，确保项目构建的一致性。
• Pipfile：定义了项目的依赖项，包括 sanpy 本身以及可能使用的其他库。

在项目启动和运行之前，需要确保配置文件正确设置，并安装所有依赖项。可以通过运行以下命令安装项目依赖：

pip install -r Pipfile

或者，如果使用 pipenv，可以运行：

pipenv install

完成依赖安装后，即可使用 sanpy 库进行数据访问和分析。