PyKis 项目使用说明

PyKis 项目使用说明

1. 项目目录结构及介绍

PyKis 是一个开源项目，旨在为韩国投资证券（KIS）的开放API提供Python支持。以下是项目的目录结构及其简要介绍：

python-kis/
├── .github/              # GitHub 工作流和配置文件
├── pykis/                # PyKis 库的主要代码
│   ├── __init__.py       # 初始化文件
│   ├── KisAccount.py     # 账户相关类
│   ├── KisAuth.py        # 认证相关类
│   ├── KisBalance.py     # 账户余额相关类
│   ├── KisOrder.py       # 订单相关类
│   ├── KisQuote.py       # 引用相关类
│   ├── KisRealtimePrice.py # 实时价格相关类
│   └── KisWebsocketClient.py # 网络客户端相关类
├── tests/                # 测试代码
├── .gitattributes        # Git 属性配置
├── .gitignore            # Git 忽略文件
├── LICENCE               # 项目许可证
├── README.md             # 项目说明文件
└── pyproject.toml        # 项目配置文件

• .github/：包含GitHub Actions的工作流和配置文件，用于自动化测试、构建等任务。
• pykis/：包含项目的主要Python代码，包括类和函数。
• tests/：包含测试代码，用于验证项目的功能。
• .gitattributes：`定义Git属性的配置。
• .gitignore：指定Git应该忽略的文件和目录。
• LICENCE：项目使用的许可证信息。
• README.md：项目的说明文件，包含项目的介绍、使用方法和贡献指南。
• pyproject.toml：项目的配置文件，用于定义项目的元数据和依赖。

2. 项目的启动文件介绍

在PyKis项目中，并没有特定的启动文件，因为该项目是一个库，旨在被其他Python项目导入使用。若要使用PyKis，需要在你的Python项目中导入PyKis库，并创建相应的对象来与KIS API进行交互。

以下是一个简单的示例：

from pykis import PyKis, KisAuth

# 创建认证对象
auth = KisAuth(id="your_id", appkey="your_appkey", secretkey="your_secretkey", account="your_account")

# 创建PyKis对象
kis = PyKis(auth)

# 使用PyKis对象进行操作，例如获取股票报价
stock = kis.stock("NVDA")
quote = stock.quote()
print(quote)

3. 项目的配置文件介绍

PyKis项目的配置主要通过pyproject.toml文件进行。以下是pyproject.toml文件的一个示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
name = "python-kis"
version = "0.1.0"
author = "Soju06"
author-email = "soju06@example.com"
description = "A Python library for Korean Investment & Securities (KIS) API"
long-description = "This is a longer description of the python-kis package..."
license = "MIT"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
]
python-requires = ">=3.7"
install-requires = [
    "requests>=2.32.3",
    "websocket-client>=1.8.0",
    "cryptography>=43.0.0",
    "colorlog>=6.8.2",
]

这个配置文件定义了以下内容：

• 项目的名称、版本、作者、描述和许可证。
• 项目依赖的构建系统和工具。
• 项目需要的Python版本和依赖的包。

这个文件被用于包的构建和发布，确保所有的依赖都能正确安装。