vnpy_ctp

To install the package in editable (developer) mode into your current Python environment, use the following command. This is useful when you are modifying the source code.

pip install -e . --no-build-isolation --config-settings=build-dir=.\vnpy_ctp\api

To install from the source code, download/clone the repository and run the install command from the root directory.

Note: Source installation requires a C++ compiler. Ensure you have installed:

• Windows: Visual Studio
• Linux: GCC
• Mac: XCode

pip install .

You can install the vnpy_ctp package directly from PyPI using pip. It is recommended to use an environment based on VeighNa Studio (version 4.0.0 or higher).

pip install vnpy_ctp

Due to changes in the CTP Mac system API structure (using a framework directory), pre-compiled wheel binaries are not available on PyPI for macOS. You must compile from source.

Requirements:

• You must have the XCode development tools (specifically the C++ compiler) installed.

Installation Steps:

1. Clone the repository.
2. Navigate to the directory.
3. Install using pip3.

git clone https://github.com/vnpy/vnpy_ctp.git
cd vnpy_ctp
pip3 install .

To use the CTP gateway, import CtpGateway from vnpy_ctp and add it to your MainEngine using add_gateway(). Below is a complete script example to initialize the engines and start the UI.

from vnpy.event import EventEngine
from vnpy.trader.engine import MainEngine
from vnpy.trader.ui import MainWindow, create_qapp

from vnpy_ctp import CtpGateway


def main():
    """主入口函数"""
    qapp = create_qapp()

    event_engine = EventEngine()
    main_engine = MainEngine(event_engine)
    main_engine.add_gateway(CtpGateway)
    
    main_window = MainWindow(main_engine, event_engine)
    main_window.showMaximized()

    qapp.exec()


if __name__ == "__main__":
    main()

The CtpGateway class is the primary entry point for interacting with the CTP (Comprehensive Trading Platform) interface within the VeighNa framework. It is exported from the vnpy_ctp package and is intended to be used as a gateway component within the VeighNa engine to handle market data and order execution via CTP.

from vnpy_ctp import CtpGateway

# The CtpGateway instance can then be used within the VeighNa engine
# to manage CTP connections, subscriptions, and trading.

The current version of the vnpy_ctp package can be accessed via the __version__ attribute. If the package is not installed in a way that allows metadata retrieval, it defaults to "dev".

import vnpy_ctp
print(vnpy_ctp.__version__)