首页
/ PyCardano 开源项目安装与使用指南

PyCardano 开源项目安装与使用指南

2024-09-12 19:55:55作者:曹令琨Iris

一、项目目录结构及介绍

PyCardano 是一个轻量级的 Cardano 库,完全由 Python 实现。此库允许开发者在不依赖 cardano-clicardano-serialization-lib 等第三方工具的情况下创建和签名交易。以下是该项目的基本目录结构概览:

.
├── CHANGELOG.md     # 版本更新日志
├── Flake8           # 代码风格检查配置
├── LICENSE          # 许可证文件,采用 MIT 许可
├── Makefile         # 构建与测试任务脚本
├── README.md        # 项目介绍和快速入门指南
├── coveragerc       # 覆盖率报告配置
├── gitignore        # Git 忽略文件列表
├── pycardano        # 主要的源码模块
│   ├── __init__.py   # 初始化文件
│   └── ...           # 包含各类功能实现的子模块(如钥匙管理、交易构建等)
├── readthedocs.yaml # ReadTheDocs 配置文件
├── tests             # 测试套件目录
│   ├── __init__.py
│   └── ...           # 单元测试文件
├── tox.ini           # 多环境测试配置
├── poetry.lock      # 依赖锁定文件
└── pyproject.toml   # 项目配置,包括依赖项和构建指令

每个主要的源码模块负责不同的功能,如地址处理、交易构建与签名、智能合约支持等。tests 目录则包含了确保这些功能正确性的测试案例。

二、项目启动文件介绍

PyCardano 不直接提供一个传统的“启动”文件,它的使用更侧重于作为导入到其他应用中的库。用户通常通过在自己的 Python 脚本中导入 PyCardano 的相关模块来开始工作,例如:

import pycardano

随后,你可以利用 PyCardano 的 API 来执行具体操作,比如创建地址、构建交易、签署交易等。

三、项目的配置文件介绍

PyCardano 本身并不强调外部配置文件的概念,其配置更多地体现在如何设置环境以适应不同的网络环境(如主网或测试网)以及处理密钥和地址的方式。对于环境配置,开发者通常会在使用链上下文(如 BlockFrostChainContext 或通过 Ogmios 连接时)通过代码直接指定参数。

不过,如果需要进行特定配置,如设定开发环境的依赖版本或是自定义测试环境的参数,开发者会依赖 pyproject.tomlMakefile 进行管理和自定义。此外,对于集成到更大的应用程序中,配置通常是通过应用程序自身的配置机制(如环境变量、应用内配置文件)来实现对 PyCardano 的定制化调用。

示例配置调整可能涉及修改 pyproject.toml 中的依赖版本,或者在使用前设定好必要的环境变量来指向区块链服务接口。

总之,PyCardano的设计鼓励通过编程方式来配置和使用,而不是依赖于独立的配置文件来进行项目初始化或运行设置。

登录后查看全文
热门项目推荐