finctx 0.3.0__tar.gz

finctx-0.3.0/.gitignore

@@ -0,0 +1,17 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+build/
+dist/
+*.egg-info/
+.env
+.env.*
+!.env.example
+.DS_Store
+skill-setup/skills/
+skill-setup/.skill-package-*/

finctx-0.3.0/LICENSE

@@ -0,0 +1,186 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+(50%) or more of the outstanding shares, or (iii) beneficial ownership of
+such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source,
+and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled
+object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as a
+whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the
+purposes of this definition, "submitted" means any form of electronic,
+verbal, or written communication sent to the Licensor or its representatives,
+including but not limited to communication on electronic mailing lists, source
+code control systems, and issue tracking systems that are managed by, or on
+behalf of, the Licensor for the purpose of discussing and improving the Work,
+but excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed
+by their Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You institute
+patent litigation against any entity (including a cross-claim or counterclaim
+in a lawsuit) alleging that the Work or a Contribution incorporated within
+the Work constitutes direct or contributory patent infringement, then any
+patent licenses granted to You under this License for that Work shall
+terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy of
+the attribution notices contained within such NOTICE file, excluding those
+notices that do not pertain to any part of the Derivative Works, in at least
+one of the following places: within a NOTICE text file distributed as part of
+the Derivative Works; within the Source form or documentation, if provided
+along with the Derivative Works; or, within a display generated by the
+Derivative Works, if and wherever such third-party notices normally appear.
+The contents of the NOTICE file are for informational purposes only and do
+not modify the License. You may add Your own attribution notices within
+Derivative Works that You distribute, alongside or as an addendum to the
+NOTICE text from the Work, provided that such additional attribution notices
+cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and distribution
+of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein
+shall supersede or modify the terms of any separate license agreement you may
+have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the Work
+and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability
+to use the Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses), even if such Contributor has been advised of
+the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification
+within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

finctx-0.3.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.5
+Name: finctx
+Version: 0.3.0
+Summary: Finctx SDK for the Finctx Data API
+Project-URL: Homepage, https://www.ultrastiching.com
+Author: Finctx
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: requests<3,>=2.31
+Requires-Dist: urllib3<2,>=1.26.20; python_version < '3.10'
+Requires-Dist: websocket-client<1.9,>=1.8
+Provides-Extra: arrow
+Requires-Dist: pyarrow>=14; extra == 'arrow'
+Provides-Extra: marketdb
+Requires-Dist: duckdb<1.6,>=1.4.1; extra == 'marketdb'
+Provides-Extra: test
+Requires-Dist: duckdb<1.6,>=1.4.1; extra == 'test'
+Requires-Dist: pyarrow>=14; extra == 'test'
+Requires-Dist: pytest<10,>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Finctx Python SDK
+
+在 Python 中查询股票、基金、财务和宏观数据，读取主题跟踪资讯，或订阅实时快讯。
+
+## 1. 安装
+
+需要 Python 3.9 或更高版本。安装下载的 SDK 包：
+
+```bash
+python -m pip install ./finctx-0.3.0-py3-none-any.whl
+```
+
+也可以直接安装源码包：
+
+```bash
+python -m pip install ./finctx-0.3.0.tar.gz
+```
+
+需要处理 Arrow 数据或使用本地数据库时，再安装相应扩展：
+
+```bash
+python -m pip install "finctx[arrow]==0.3.0"     # Arrow 数据转换
+python -m pip install "finctx[marketdb]==0.3.0"  # 本地数据库
+```
+
+## 2. 配置 API Key
+
+在 [Finctx 网站](https://www.ultrastiching.com)创建 API Key，然后在运行 Python 的环境中设置：
+
+```bash
+export FINCTX_API_KEY="<你的 API Key>"
+```
+
+Windows PowerShell 使用 `$env:FINCTX_API_KEY = "<你的 API Key>"`。不要将真实 Key 写入代码或提交到 Git。
+
+也可以将 `FINCTX_API_KEY=<你的 API Key>` 保存到 `~/.finctx/credentials.env`，并将文件权限设为仅当前用户可读写（Linux／macOS 使用 `chmod 600 ~/.finctx/credentials.env`）。SDK 按“传入的 `api_key` → 环境变量 → 用户凭据文件”的顺序读取 Key，不会自动加载项目的 `.env`。
+
+## 3. 第一次查询
+
+下面查询证券简称，并把结果提取为 Python 字典列表：
+
+```python
+from finctx import FinctxClient
+
+with FinctxClient() as client:
+    result = client.get_s_stockname(code=["600745.SH"])
+    rows = client.rows(result)
+    print(rows)
+```
+
+接口调用需要相应权限，并按账号的额度和计费规则使用。`rows()` 适用于包含 `data_frame` 的表格结果；如果响应格式不符，会抛出错误。
+
+## 查找接口和参数
+
+这些查询在本地执行，无需 API Key：
+
+```python
+from finctx import FinctxClient
+
+print(FinctxClient.endpoints()["daily"]["parameters"])
+print(FinctxClient.fields("daily", search="收盘"))
+help(FinctxClient.daily)
+```
+
+`endpoints()` 列出可调用的接口及其参数，`fields()` 查找返回字段，`help()` 查看方法签名。调用业务方法时使用关键字参数；具体返回内容取决于所选接口。
+
+## 处理 Arrow 数据
+
+安装 `arrow` 扩展后，可以把 Arrow 结果转换成表格：
+
+```python
+from finctx import FinctxClient
+
+with FinctxClient() as client:
+    raw = client.arrow(
+        handler="get_s_stockname",
+        params={"code": ["600745.SH"]},
+        fields=["code", "sename"],
+    )
+    table = client.arrow_to_table(raw)
+    print(table.to_pylist())
+```
+
+Arrow 接口返回原始 bytes，转换由调用方显式执行。
+
+## 读取主题跟踪资讯
+
+读取关注范围的内容、搜索资讯，或查看关注的主题：
+
+```python
+from finctx import FinctxClient
+
+with FinctxClient() as client:
+    feed = client.get_tracer_feed(limit=20)
+    print(feed["items"])
+
+    page = client.search_tracer_content(q="美债", scope="following", limit=20)
+    print(page["items"])
+
+    topics = client.list_tracer_topics()
+    print(topics)
+```
+
+资讯结果使用 `items`，直接读取，不调用 `rows()`。新闻搜索返回 `has_more=True` 时，下一页传入 `next_cursor`，并保留相同筛选条件及返回的时间范围；Python 参数 `from_`、`to` 分别使用 `window["from"]`、`window["to"]`。
+
+主题创建使用 `create_tracer_topic(query=...)`；关注和取消关注使用 `follow_tracer_topic(id=...)`、`unfollow_tracer_topic(id=...)`，主题 ID 从主题列表取得。创建回执表示任务已受理，不代表内容已生成完成。
+
+## 订阅实时快讯
+
+```python
+from finctx import FinctxClient
+
+with FinctxClient() as client:
+    with client.ws_newsflash(limit=10) as stream:
+        print(stream.receive_json())
+```
+
+SDK 不自动重连。持续订阅时，由应用保存已处理消息的游标并处理断线。主题跟踪的 SSE 推送需使用支持流式读取的 HTTP 客户端，SDK 的 `request()` 不支持持续读取 SSE。
+
+## 使用本地数据库
+
+安装 `marketdb` 扩展后，可以将数据保存到本地 DuckDB 文件，并用 SQL 查询：
+
+```python
+from finctx.marketdb import DATASETS, MarketDB
+
+db = MarketDB()
+db.init()
+print(sorted(DATASETS))  # 查看支持同步的数据集
+print(db.status())      # 查看本地数据和同步记录
+```
+
+通过 `db.sync(数据集名称, **查询参数)` 下载数据，`db.sql(SQL)` 执行只读查询，`db.export(表名, 文件路径)` 导出 CSV 或 Parquet。
+
+同步后检查返回的 `status`：`complete` 表示本次查询范围已完整写入，`incomplete` 表示未确认完整，不写入数据。单次同步上限为 100,000 行或约 64 MiB；超限时缩小查询范围。`validate()` 检查本地数据库，不验证远端是否还有更多历史数据。
+
+## 调整地址和超时
+
+通常只需配置 API Key。需要覆盖默认设置时使用：
+
+| 设置 | 默认值 | 配置方式 |
+| --- | --- | --- |
+| HTTP 服务地址 | `https://api.ultrastiching.com` | `base_url=` 或 `FINCTX_BASE_URL` |
+| HTTP 超时 | 30 秒 | `timeout=` |
+| WebSocket 服务地址 | `wss://ws.ultrastiching.com` | `websocket_base_url=` |
+| WebSocket 超时 | 30 秒 | `websocket_timeout=` |
+| 本地数据库路径 | `~/.finctx/data/marketdb.duckdb` | `MarketDB(path=...)` 或 `FINCTX_DB` |
+
+显式参数优先于环境变量。服务地址需包含协议，如 `https://api.example.com`，可带端口，不附带接口路径、查询参数或片段；HTTP 地址设置不会同时修改 WebSocket 地址。
+
+## 处理错误
+
+```python
+from finctx import FinctxApiError, FinctxClient, FinctxTransportError
+
+try:
+    with FinctxClient() as client:
+        result = client.get_s_stockname(code=["600745.SH"])
+except FinctxApiError as error:
+    print(error.status_code, error.error_code, error.request_id)
+except FinctxTransportError as error:
+    print(error.cause)
+```
+
+`FinctxApiError` 提供 HTTP 状态、服务端错误码、请求编号和原始响应；`FinctxTransportError` 提供网络错误原因。响应无法解析为 JSON 时抛出 `FinctxResponseError`，表格结果格式不符时抛出 `FinctxResultError`。根据具体错误处理，SDK 默认不自动重试。
+
+## 从旧版升级
+
+0.3.0 的安装包与导入名统一为 `finctx`，客户端为 `FinctxClient`，异常类使用 `Finctx` 前缀。升级时更新导入、异常捕获和环境变量；新版不自动读取旧配置或旧用户目录。已有数据库可通过 `FINCTX_DB` 或 `MarketDB(path=...)` 继续打开。
+
+许可证：[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)。

finctx-0.3.0/README.md

@@ -0,0 +1,171 @@
+# Finctx Python SDK
+
+在 Python 中查询股票、基金、财务和宏观数据，读取主题跟踪资讯，或订阅实时快讯。
+
+## 1. 安装
+
+需要 Python 3.9 或更高版本。安装下载的 SDK 包：
+
+```bash
+python -m pip install ./finctx-0.3.0-py3-none-any.whl
+```
+
+也可以直接安装源码包：
+
+```bash
+python -m pip install ./finctx-0.3.0.tar.gz
+```
+
+需要处理 Arrow 数据或使用本地数据库时，再安装相应扩展：
+
+```bash
+python -m pip install "finctx[arrow]==0.3.0"     # Arrow 数据转换
+python -m pip install "finctx[marketdb]==0.3.0"  # 本地数据库
+```
+
+## 2. 配置 API Key
+
+在 [Finctx 网站](https://www.ultrastiching.com)创建 API Key，然后在运行 Python 的环境中设置：
+
+```bash
+export FINCTX_API_KEY="<你的 API Key>"
+```
+
+Windows PowerShell 使用 `$env:FINCTX_API_KEY = "<你的 API Key>"`。不要将真实 Key 写入代码或提交到 Git。
+
+也可以将 `FINCTX_API_KEY=<你的 API Key>` 保存到 `~/.finctx/credentials.env`，并将文件权限设为仅当前用户可读写（Linux／macOS 使用 `chmod 600 ~/.finctx/credentials.env`）。SDK 按“传入的 `api_key` → 环境变量 → 用户凭据文件”的顺序读取 Key，不会自动加载项目的 `.env`。
+
+## 3. 第一次查询
+
+下面查询证券简称，并把结果提取为 Python 字典列表：
+
+```python
+from finctx import FinctxClient
+
+with FinctxClient() as client:
+    result = client.get_s_stockname(code=["600745.SH"])
+    rows = client.rows(result)
+    print(rows)
+```
+
+接口调用需要相应权限，并按账号的额度和计费规则使用。`rows()` 适用于包含 `data_frame` 的表格结果；如果响应格式不符，会抛出错误。
+
+## 查找接口和参数
+
+这些查询在本地执行，无需 API Key：
+
+```python
+from finctx import FinctxClient
+
+print(FinctxClient.endpoints()["daily"]["parameters"])
+print(FinctxClient.fields("daily", search="收盘"))
+help(FinctxClient.daily)
+```
+
+`endpoints()` 列出可调用的接口及其参数，`fields()` 查找返回字段，`help()` 查看方法签名。调用业务方法时使用关键字参数；具体返回内容取决于所选接口。
+
+## 处理 Arrow 数据
+
+安装 `arrow` 扩展后，可以把 Arrow 结果转换成表格：
+
+```python
+from finctx import FinctxClient
+
+with FinctxClient() as client:
+    raw = client.arrow(
+        handler="get_s_stockname",
+        params={"code": ["600745.SH"]},
+        fields=["code", "sename"],
+    )
+    table = client.arrow_to_table(raw)
+    print(table.to_pylist())
+```
+
+Arrow 接口返回原始 bytes，转换由调用方显式执行。
+
+## 读取主题跟踪资讯
+
+读取关注范围的内容、搜索资讯，或查看关注的主题：
+
+```python
+from finctx import FinctxClient
+
+with FinctxClient() as client:
+    feed = client.get_tracer_feed(limit=20)
+    print(feed["items"])
+
+    page = client.search_tracer_content(q="美债", scope="following", limit=20)
+    print(page["items"])
+
+    topics = client.list_tracer_topics()
+    print(topics)
+```
+
+资讯结果使用 `items`，直接读取，不调用 `rows()`。新闻搜索返回 `has_more=True` 时，下一页传入 `next_cursor`，并保留相同筛选条件及返回的时间范围；Python 参数 `from_`、`to` 分别使用 `window["from"]`、`window["to"]`。
+
+主题创建使用 `create_tracer_topic(query=...)`；关注和取消关注使用 `follow_tracer_topic(id=...)`、`unfollow_tracer_topic(id=...)`，主题 ID 从主题列表取得。创建回执表示任务已受理，不代表内容已生成完成。
+
+## 订阅实时快讯
+
+```python
+from finctx import FinctxClient
+
+with FinctxClient() as client:
+    with client.ws_newsflash(limit=10) as stream:
+        print(stream.receive_json())
+```
+
+SDK 不自动重连。持续订阅时，由应用保存已处理消息的游标并处理断线。主题跟踪的 SSE 推送需使用支持流式读取的 HTTP 客户端，SDK 的 `request()` 不支持持续读取 SSE。
+
+## 使用本地数据库
+
+安装 `marketdb` 扩展后，可以将数据保存到本地 DuckDB 文件，并用 SQL 查询：
+
+```python
+from finctx.marketdb import DATASETS, MarketDB
+
+db = MarketDB()
+db.init()
+print(sorted(DATASETS))  # 查看支持同步的数据集
+print(db.status())      # 查看本地数据和同步记录
+```
+
+通过 `db.sync(数据集名称, **查询参数)` 下载数据，`db.sql(SQL)` 执行只读查询，`db.export(表名, 文件路径)` 导出 CSV 或 Parquet。
+
+同步后检查返回的 `status`：`complete` 表示本次查询范围已完整写入，`incomplete` 表示未确认完整，不写入数据。单次同步上限为 100,000 行或约 64 MiB；超限时缩小查询范围。`validate()` 检查本地数据库，不验证远端是否还有更多历史数据。
+
+## 调整地址和超时
+
+通常只需配置 API Key。需要覆盖默认设置时使用：
+
+| 设置 | 默认值 | 配置方式 |
+| --- | --- | --- |
+| HTTP 服务地址 | `https://api.ultrastiching.com` | `base_url=` 或 `FINCTX_BASE_URL` |
+| HTTP 超时 | 30 秒 | `timeout=` |
+| WebSocket 服务地址 | `wss://ws.ultrastiching.com` | `websocket_base_url=` |
+| WebSocket 超时 | 30 秒 | `websocket_timeout=` |
+| 本地数据库路径 | `~/.finctx/data/marketdb.duckdb` | `MarketDB(path=...)` 或 `FINCTX_DB` |
+
+显式参数优先于环境变量。服务地址需包含协议，如 `https://api.example.com`，可带端口，不附带接口路径、查询参数或片段；HTTP 地址设置不会同时修改 WebSocket 地址。
+
+## 处理错误
+
+```python
+from finctx import FinctxApiError, FinctxClient, FinctxTransportError
+
+try:
+    with FinctxClient() as client:
+        result = client.get_s_stockname(code=["600745.SH"])
+except FinctxApiError as error:
+    print(error.status_code, error.error_code, error.request_id)
+except FinctxTransportError as error:
+    print(error.cause)
+```
+
+`FinctxApiError` 提供 HTTP 状态、服务端错误码、请求编号和原始响应；`FinctxTransportError` 提供网络错误原因。响应无法解析为 JSON 时抛出 `FinctxResponseError`，表格结果格式不符时抛出 `FinctxResultError`。根据具体错误处理，SDK 默认不自动重试。
+
+## 从旧版升级
+
+0.3.0 的安装包与导入名统一为 `finctx`，客户端为 `FinctxClient`，异常类使用 `Finctx` 前缀。升级时更新导入、异常捕获和环境变量；新版不自动读取旧配置或旧用户目录。已有数据库可通过 `FINCTX_DB` 或 `MarketDB(path=...)` 继续打开。
+
+许可证：[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)。

finctx-0.3.0/demo.py

@@ -0,0 +1,40 @@
+"""Finctx Python SDK 源码交付调用示例。"""
+
+from finctx import (
+    FinctxApiError,
+    FinctxClient,
+    FinctxResponseError,
+    FinctxTransportError,
+)
+
+
+# 使用时替换为实际 API 地址和凭证；不要将真实 API Key 提交到 Git。
+base_url = "https://api.ultrastiching.com"
+api_key = "replace-with-your-api-key"
+
+
+def main() -> None:
+    try:
+        with FinctxClient(
+            base_url=base_url,
+            api_key=api_key,
+        ) as client:
+            result = client.get_s_majorbiz(
+                code=["600745", "603986"],
+                trade_date=["20240705", "20240704"],
+            )
+            print(result)
+    except FinctxApiError as error:
+        print(
+            f"API 调用失败：status={error.status_code}, "
+            f"code={error.error_code}, message={error.message}, "
+            f"request_id={error.request_id}"
+        )
+    except FinctxTransportError as error:
+        print(f"网络调用失败：{error}")
+    except FinctxResponseError as error:
+        print(f"响应不是合法 JSON：request_id={error.request_id}")
+
+
+if __name__ == "__main__":
+    main()

finctx-0.3.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "finctx"
+dynamic = ["version"]
+description = "Finctx SDK for the Finctx Data API"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+authors = [{ name = "Finctx" }]
+dependencies = [
+  "requests>=2.31,<3",
+  "urllib3>=1.26.20,<2; python_version < '3.10'",
+  "websocket-client>=1.8,<1.9",
+]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://www.ultrastiching.com"
+
+[project.optional-dependencies]
+arrow = ["pyarrow>=14"]
+marketdb = ["duckdb>=1.4.1,<1.6"]
+test = ["pytest>=8,<10", "duckdb>=1.4.1,<1.6", "pyarrow>=14"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/finctx"]
+
+[tool.hatch.version]
+path = "src/finctx/_version.py"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

finctx-0.3.0/src/finctx/__init__.py

@@ -0,0 +1,24 @@
+"""Public interface for the Finctx Data API Python SDK."""
+
+from ._version import __version__
+from .client import FinctxClient, FinctxWebSocket
+from .exceptions import (
+    FinctxApiError,
+    FinctxError,
+    FinctxResponseError,
+    FinctxResultError,
+    FinctxTransportError,
+    FinctxWebSocketMessageError,
+)
+
+__all__ = [
+    "FinctxApiError",
+    "FinctxClient",
+    "FinctxError",
+    "FinctxResponseError",
+    "FinctxResultError",
+    "FinctxTransportError",
+    "FinctxWebSocket",
+    "FinctxWebSocketMessageError",
+    "__version__",
+]

finctx-0.3.0/src/finctx/_version.py

@@ -0,0 +1,3 @@
+"""Single source of truth for the Finctx Python SDK version."""
+
+__version__ = "0.3.0"