EthTx 项目使用教程
1. 项目目录结构及介绍
EthTx 项目的目录结构如下:
ethtx/
├── github/
│ └── workflows/
├── scripts/
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── DEVELOPMENT.md
├── LICENSE
├── MANIFEST.in
├── Makefile
├── NOTICE
├── Pipfile
├── README.md
├── setup.cfg
└── setup.py
目录结构介绍
- github/workflows/:包含 GitHub Actions 的工作流配置文件。
- scripts/:包含项目的脚本文件。
- tests/:包含项目的测试文件。
- .gitignore:Git 忽略文件配置。
- .pre-commit-config.yaml:预提交钩子配置文件。
- CHANGELOG.md:项目更新日志。
- DEVELOPMENT.md:开发指南。
- LICENSE:项目许可证文件。
- MANIFEST.in:Python 包的清单文件。
- Makefile:Makefile 文件,用于自动化构建和测试。
- NOTICE:项目通知文件。
- Pipfile:Pipenv 依赖管理文件。
- README.md:项目介绍和使用说明。
- setup.cfg:Python 包配置文件。
- setup.py:Python 包安装脚本。
2. 项目启动文件介绍
EthTx 项目的启动文件主要是 setup.py
和 setup.cfg
。
setup.py
setup.py
是 Python 项目的标准安装脚本,用于定义项目的元数据和依赖项。通过运行 python setup.py install
可以安装项目。
setup.cfg
setup.cfg
是 Python 包的配置文件,用于定义包的元数据、依赖项和其他配置选项。它通常与 setup.py
配合使用。
3. 项目配置文件介绍
EthTx 项目的主要配置文件是 setup.cfg
和 Pipfile
。
setup.cfg
setup.cfg
文件中定义了项目的元数据、依赖项和其他配置选项。例如:
[metadata]
name = ethtx
version = 0.1.0
description = Python package with core transaction decoding functions
author = EthTx Team
license = Apache-2.0
[options]
packages = find:
install_requires =
web3
pymongo
requests
Pipfile
Pipfile
是 Pipenv 工具的依赖管理文件,用于定义项目的依赖项和开发依赖项。例如:
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
web3 = "*"
pymongo = "*"
requests = "*"
[dev-packages]
pytest = "*"
通过这些配置文件,可以方便地管理和安装项目的依赖项,并进行项目的构建和测试。