Etherscan-Python 项目教程

1. 项目目录结构及介绍

etherscan-python/
├── etherscan/
│   ├── __init__.py
│   ├── api.py
│   ├── exceptions.py
│   ├── utils.py
├── tests/
│   ├── __init__.py
│   ├── test_accounts.py
│   ├── test_contracts.py
│   ├── test_transactions.py
│   ├── test_blocks.py
│   ├── test_tokens.py
│   ├── test_gas_tracker.py
│   ├── test_stats.py
├── logs/
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── run_tests.sh
├── setup.py

目录结构说明

• etherscan/: 包含项目的主要代码文件。

  • __init__.py: 初始化文件，使该目录成为一个Python包。
  • api.py: 包含与Etherscan API交互的主要功能。
  • exceptions.py: 定义了项目中可能抛出的异常。
  • utils.py: 包含一些辅助函数和工具。

• tests/: 包含项目的单元测试文件。

  • __init__.py: 初始化文件，使该目录成为一个Python包。
  • test_*.py: 各个模块的单元测试文件。

• logs/: 用于存储测试日志文件。

• .gitignore: Git忽略文件，指定哪些文件和目录不应被版本控制。

• LICENSE: 项目的开源许可证文件。

• MANIFEST.in: 包含在打包时需要包含的额外文件。

• README.md: 项目的说明文档。

• run_tests.sh: 运行单元测试的脚本。

• setup.py: 项目的安装脚本。

2. 项目启动文件介绍

项目的启动文件主要是 setup.py 和 run_tests.sh。

setup.py

setup.py 是Python项目的标准安装脚本。它包含了项目的元数据和依赖信息，可以通过以下命令安装项目：

pip install .

run_tests.sh

run_tests.sh 是一个用于运行单元测试的脚本。在终端中执行以下命令可以运行所有测试：

bash run_tests.sh YOUR_API_KEY

其中 YOUR_API_KEY 是你在Etherscan.io注册并生成的API密钥。

3. 项目的配置文件介绍

项目中没有显式的配置文件，但可以通过以下方式进行配置：

API密钥配置

在使用项目时，你需要在代码中配置你的Etherscan API密钥。例如：

from etherscan import Etherscan

eth = Etherscan(YOUR_API_KEY)  # 将 YOUR_API_KEY 替换为你的实际API密钥

测试配置

在运行单元测试时，你需要在 run_tests.sh 脚本中提供你的API密钥。测试脚本会自动使用该密钥进行测试。

bash run_tests.sh YOUR_API_KEY

通过以上配置，你可以在本地环境中使用和测试 etherscan-python 项目。