xtquant-share 1.2.8__tar.gz → 1.2.9__tar.gz

{xtquant_share-1.2.8 → xtquant_share-1.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xtquant-share
-Version: 1.2.8
+Version: 1.2.9
 Summary: Xtreme Quant Share - eXtreme transparent sharing proxy for XtQuant on macOS/Linux
 Author-email: Jason Hu <63170682@qq.com>
 License-Expression: GPL-3.0-only

{xtquant_share-1.2.8 → xtquant_share-1.2.9}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xtquant-share"
-version = "1.2.8"
+version = "1.2.9"
 description = "Xtreme Quant Share - eXtreme transparent sharing proxy for XtQuant on macOS/Linux"
 readme = "README.md"
 license = "GPL-3.0-only"
@@ -70,4 +70,4 @@ where = ["."]
 include = ["xqshare*"]
 
 [tool.setuptools.package-data]
-"*" = ["*.md", "*.txt", "*.yaml", "*.example"]
+"*" = ["*.md", "*.txt", "*.yaml", "*.example", ".env.example"]

xtquant_share-1.2.9/xqshare/.env.example

@@ -0,0 +1,26 @@
+# xqshare 服务端环境变量配置
+# 此文件由 xqshare-server 首次启动时自动生成
+# 请根据你的实际环境修改以下配置，然后重新启动服务
+
+# ==================== 服务配置 ====================
+# 服务监听端口
+XQSHARE_PORT=18812
+
+# ==================== QMT 配置 ====================
+# QMT 客户端 userdata_mini 目录路径（必填）
+# 示例：QMT_USERDATA_PATH=C:\QMT\userdata_mini
+QMT_USERDATA_PATH=C:\QMT\userdata_mini
+
+# 默认资金账号（可选）
+# QMT_ACCOUNT_ID=你的资金账号
+
+# QMT datadir 文件解析路径（用于 xqshare.datadir 功能）
+# 优先级：QMT_DATADIR_PATH > xtdata.get_data_dir() 自动推断
+# 若不配置，系统将尝试通过 xtdata.get_data_dir() 自动推断主数据目录
+# 示例（国金证券）：QMT_DATADIR_PATH=D:\国金证券QMT交易端\datadir
+# 示例（通用路径）：QMT_DATADIR_PATH=C:\QMT\datadir
+# QMT_DATADIR_PATH=
+
+# ==================== 日志配置 ====================
+# 日志级别: DEBUG, INFO, WARNING, ERROR
+LOG_LEVEL=INFO

{xtquant_share-1.2.8 → xtquant_share-1.2.9}/xqshare/server.py

@@ -703,6 +703,31 @@ def _init_clients_yaml():
         logger.warning(f"自动复制 clients.yaml.example 失败: {e}")
 
 
+def _init_env_file():
+    """
+    如果当前工作目录下不存在 .env 文件，则从包目录复制示例文件。
+
+    这样用户 pip install 后首次运行即可得到一份带注释的 .env 模板，
+    避免因缺少配置文件而导致服务无法正常启动。
+    """
+    import shutil
+    target = os.path.join(os.getcwd(), ".env")
+    if os.path.exists(target):
+        return  # 已存在，跳过
+
+    # 从包目录查找示例文件
+    example_path = os.path.join(os.path.dirname(__file__), ".env.example")
+    if not os.path.exists(example_path):
+        return  # 示例文件也不存在（不应发生）
+
+    try:
+        shutil.copyfile(example_path, target)
+        print(f"  \u2714 已生成 .env 配置文件")
+        print(f"    ⚠ 请编辑 .env 文件，设置 QMT_USERDATA_PATH 等必要配置后重新启动服务")
+    except Exception as e:
+        logger.warning(f"自动复制 .env.example 失败: {e}")
+
+
 # ==================== datadir 初始化 ====================
 
 def _init_datadir_reader():
@@ -806,6 +831,9 @@ def start_server(host="0.0.0.0", port=None, use_ssl=False, certfile=None, keyfil
     print(f"  日志级别: {log_level}")
     print("=" * 70)
     
+    # ── 自动生成 .env（首次启动时拷贝模板） ───────────────────────
+    _init_env_file()
+
     # ── 自动生成 clients.yaml ──────────────────────────────────────
     _init_clients_yaml()
 

{xtquant_share-1.2.8 → xtquant_share-1.2.9}/xtquant_share.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xtquant-share
-Version: 1.2.8
+Version: 1.2.9
 Summary: Xtreme Quant Share - eXtreme transparent sharing proxy for XtQuant on macOS/Linux
 Author-email: Jason Hu <63170682@qq.com>
 License-Expression: GPL-3.0-only

{xtquant_share-1.2.8 → xtquant_share-1.2.9}/xtquant_share.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ tests/test_integration.py
 tests/test_server.py
 tests/test_server_permission.py
 tests/test_tools_common.py
+xqshare/.env.example
 xqshare/__init__.py
 xqshare/auth.py
 xqshare/client.py