OrderBook 项目使用教程-优快云博客

OrderBook 项目使用教程

OrderBook Matching Engine for Limit Order Book 项目地址: https://gitcode.com/gh_mirrors/ord/OrderBook

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

OrderBook/
├── bin/
│   ├── orderbook
│   └── orderbook.gitignore
├── CHANGES.txt
├── LICENSE.txt
├── MANIFEST
├── MANIFEST.in
├── README.md
├── setup.cfg
├── setup.py
└── orderbook/
    ├── __init__.py
    ├── test/
    │   └── example.py
    └── ...

目录结构介绍

bin/: 包含项目的可执行文件和相关的配置文件。
- orderbook: 项目的可执行文件。
- orderbook.gitignore: Git 忽略文件。
CHANGES.txt: 记录项目的变更历史。
LICENSE.txt: 项目的许可证文件。
MANIFEST: 项目的清单文件。
MANIFEST.in: 项目的清单配置文件。
README.md: 项目的介绍和使用说明。
setup.cfg: 项目的配置文件。
setup.py: 项目的安装脚本。
orderbook/: 项目的主要代码目录。
- __init__.py: 初始化文件。
- test/: 测试代码目录。
  - example.py: 示例代码文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 orderbook。该文件是项目的可执行文件，用于启动 OrderBook 的匹配引擎。

启动步骤

确保已经安装了项目依赖。可以通过以下命令安装：
```
pip install orderbook
```
运行启动文件：
```
./bin/orderbook
```

3. 项目的配置文件介绍

项目的配置文件主要有两个：setup.cfg 和 setup.py。

setup.cfg

setup.cfg 是一个配置文件，用于定义项目的安装和打包选项。它通常包含以下内容：

[metadata]
name = orderbook
version = 1.0.0
description = Matching Engine for Limit Order Book
author = dyn4mik3
license = MIT

[options]
packages = find:
install_requires =
    sortedcontainers

setup.py

setup.py 是一个 Python 脚本，用于定义项目的安装和打包过程。它通常包含以下内容：

from setuptools import setup, find_packages

setup(
    name='orderbook',
    version='1.0.0',
    description='Matching Engine for Limit Order Book',
    author='dyn4mik3',
    license='MIT',
    packages=find_packages(),
    install_requires=[
        'sortedcontainers',
    ],
)