PyKiteConnect 项目教程

77 0 0

PyKiteConnect 项目教程

pykiteconnectThe official Python client library for the Kite Connect trading APIs项目地址:https://gitcode.com/gh_mirrors/py/pykiteconnect

1. 项目的目录结构及介绍

PyKiteConnect 是一个用于与 Kite Connect API 进行通信的 Python 客户端库。以下是项目的目录结构及其介绍：

pykiteconnect/ ├── examples/ # 示例代码目录 ├── kiteconnect/ # 主要代码目录 ├── tests/ # 测试代码目录 ├── .coveragerc # 代码覆盖率配置文件 ├── .gitignore # Git 忽略文件配置 ├── .gitmodules # Git 子模块配置 ├── LICENSE # 项目许可证 ├── README.md # 项目说明文档 ├── dev_requirements.txt # 开发依赖文件 ├── pytest.ini # pytest 配置文件 ├── setup.cfg # 安装配置文件 └── setup.py # 安装脚本

目录结构介绍

examples/：包含使用 PyKiteConnect 的示例代码。
kiteconnect/：包含 PyKiteConnect 的主要代码。
tests/：包含项目的测试代码。
.coveragerc：代码覆盖率配置文件。
.gitignore：Git 忽略文件配置。
.gitmodules：Git 子模块配置。
LICENSE：项目许可证。
README.md：项目说明文档。
dev_requirements.txt：开发依赖文件。
pytest.ini：pytest 配置文件。
setup.cfg：安装配置文件。
setup.py：安装脚本。

2. 项目的启动文件介绍

PyKiteConnect 项目的启动文件是 setup.py。这个文件用于安装和管理项目的依赖项。以下是 setup.py 的基本内容：


from setuptools import setup, find_packages
 
setup(
    name="pykiteconnect",
    version="4.0.0",
    packages=find_packages(),
    install_requires=[
        "requests",
        "six",
        "pyOpenSSL",
        "autobahn",
        "twisted",
        "service_identity"
    ],
    author="Zerodha Technology",
    author_email="support@kite.trade",
    description="The official Python client for communicating with the Kite Connect API",
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    url="https://github.com/zerodha/pykiteconnect",
    classifiers=[
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
    ],
)

启动文件介绍

setup.py：用于安装和管理项目的依赖项。它定义了项目的名称、版本、包、依赖项、作者、描述等信息。

3. 项目的配置文件介绍

PyKiteConnect 项目的配置文件包括 setup.cfg 和 pytest.ini。

setup.cfg

setup.cfg 是一个配置文件，用于定义安装过程中的各种选项。以下是 setup.cfg 的基本内容：

[metadata] name = pykiteconnect version = 4.0.0 author = Zerodha Technology author_email = support@kite.trade description = The official Python client for communicating with the Kite Connect API long_description = file: README.md long_description_content_type = text/markdown url = https://github.com/zerodha/pykiteconnect classifiers = License :: OSI Approved :: MIT License Programming Language :: Python :: 3 Programming Language :: Python :: 3.6 Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 [options] packages = find: install_requires = requests six pyOpenSSL autobahn twisted service_identity