dolphindb-extension 0.1.0a1__tar.gz

dolphindb_extension-0.1.0a1/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Package checks
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  package:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          version: "0.9.26"
+          python-version: ${{ matrix.python-version }}
+      - name: Check locked environment
+        run: uv sync --locked
+      - name: Build distributions
+        run: uv build --no-sources
+      - name: Check package metadata and README
+        run: uvx twine check --strict dist/*
+      - name: Verify isolated wheel installation
+        run: >-
+          uv run --isolated --no-project --with dist/*.whl
+          python -I -c "import dolphindb_extension; print(dolphindb_extension.__version__)"
+      - name: Verify isolated source distribution installation
+        run: >-
+          uv run --isolated --no-project --with dist/*.tar.gz
+          python -I -c "import dolphindb_extension; print(dolphindb_extension.__version__)"

dolphindb_extension-0.1.0a1/.gitignore

@@ -0,0 +1,30 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Local credentials and configuration
+.env
+.env.*
+!.env.example
+.pypirc
+uv.toml
+
+# Tool caches and frontend build output
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+node_modules/
+.ipynb_checkpoints/
+
+# Operating system files
+.DS_Store
+Thumbs.db

dolphindb_extension-0.1.0a1/.python-version

@@ -0,0 +1 @@
+3.12

dolphindb_extension-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.0a1 - 2026-09-10
+
+- Initialize the `dolphindb-extension` Python package with uv and Hatchling.
+- Add package metadata, a source layout, and reproducible environment setup.
+- Document the planned DolphinDB VS Code to Jupyter migration.
+- Add distribution build, metadata, and installation checks in GitHub Actions.
+
+This initial scaffold does not yet implement any Jupyter extension features.

dolphindb_extension-0.1.0a1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

dolphindb_extension-0.1.0a1/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.5
+Name: dolphindb-extension
+Version: 0.1.0a1
+Summary: DolphinDB integration for JupyterLab and Jupyter Notebook (initial scaffold).
+Project-URL: Homepage, https://github.com/realhuhu/dolphindb-extension
+Project-URL: Repository, https://github.com/realhuhu/dolphindb-extension
+Project-URL: Issues, https://github.com/realhuhu/dolphindb-extension/issues
+Project-URL: Changelog, https://github.com/realhuhu/dolphindb-extension/blob/main/CHANGELOG.md
+Author-email: realhuhu <2661467107@qq.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ddb,dolphindb,jupyter,jupyterlab,notebook
+Classifier: Development Status :: 1 - Planning
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Database :: Front-Ends
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# dolphindb-extension
+
+将 [DolphinDB VS Code 插件](https://github.com/dolphindb/vscode-extension) 的能力迁移到 Jupyter，
+支持 DolphinDB 脚本开发和 Notebook 中的 DDB 代码执行。
+
+**当前版本 `0.1.0a1` 仅包含使用 uv 初始化的 Python 包骨架。**
+此版本用于建立项目和发布流程，尚未实现 Jupyter 扩展、连接管理或代码执行功能。
+安装后不会出现侧边栏按钮、内核或 Notebook magic。
+
+## 目标功能（待实现）
+
+目标是覆盖原 VS Code 插件的全部功能，并增加 Notebook 集成；以下为主要迁移范围：
+
+- [ ] 在 Jupyter 侧边栏配置、管理和切换 DolphinDB 连接。
+- [ ] 创建、编辑 `.dos` 文件，并像选择 Python 内核一样选择执行连接。
+- [ ] 执行文件、选中代码或当前语句，显示运行状态并支持取消执行。
+- [ ] 在 Notebook 中编写和执行 DDB 代码，提供类似 SQL 的使用体验。
+- [ ] 语法高亮、代码补全、内置函数文档和参数提示。
+- [ ] 显示执行结果、`print()` 输出和错误信息。
+- [ ] 浏览数据库、表和会话变量，展示表、向量及矩阵，并导出 CSV。
+- [ ] 调试等其余能力按上游功能清单逐项迁移和验收。
+
+计划面向 JupyterLab 4 和 Jupyter Notebook 7；前端扩展、服务端连接执行层及
+Notebook 集成会在后续开发阶段加入。
+
+## 安装骨架版本
+
+需要 Python 3.10 或更高版本。
+
+```shell
+pip install dolphindb-extension==0.1.0a1
+```
+
+包的 Python 导入名称为 `dolphindb_extension`：
+
+```python
+from dolphindb_extension import __version__
+
+print(__version__)
+```
+
+## 本地开发
+
+使用 [uv](https://docs.astral.sh/uv/) 管理 Python 环境、锁文件和构建。
+开发环境固定为 Python 3.12，运行时最低支持 Python 3.10。
+
+```shell
+git clone https://github.com/realhuhu/dolphindb-extension.git
+cd dolphindb-extension
+uv sync --locked
+uv run python -c "import dolphindb_extension; print(dolphindb_extension.__version__)"
+uv build --no-sources
+uvx twine check --strict dist/*
+```
+
+源码位于 `src/dolphindb_extension/`，构建配置位于 `pyproject.toml`，
+wheel 和源码分发包输出到 `dist/`。当前包没有运行时依赖。
+GitHub Actions 会检查锁文件、构建产物和独立安装后的导入。
+
+## 发布
+
+更新 `pyproject.toml` 中的版本和 `CHANGELOG.md`，运行 `uv lock`，并在干净的
+`dist/` 目录中重新构建和检查产物。提交代码并创建对应版本的 Git 标签后发布。
+
+```shell
+uv auth login https://upload.pypi.org --username __token__
+uv publish
+```
+
+登录时在交互提示中输入 PyPI API token。凭据保存在 uv 的本机凭据存储中，
+不应写入源码、提交记录或构建产物。
+
+## 许可证
+
+采用 [Apache License 2.0](LICENSE)。本项目以 DolphinDB VS Code 插件为迁移参考；
+初始版本尚未包含迁移后的上游实现。

dolphindb_extension-0.1.0a1/README.md

@@ -0,0 +1,76 @@
+# dolphindb-extension
+
+将 [DolphinDB VS Code 插件](https://github.com/dolphindb/vscode-extension) 的能力迁移到 Jupyter，
+支持 DolphinDB 脚本开发和 Notebook 中的 DDB 代码执行。
+
+**当前版本 `0.1.0a1` 仅包含使用 uv 初始化的 Python 包骨架。**
+此版本用于建立项目和发布流程，尚未实现 Jupyter 扩展、连接管理或代码执行功能。
+安装后不会出现侧边栏按钮、内核或 Notebook magic。
+
+## 目标功能（待实现）
+
+目标是覆盖原 VS Code 插件的全部功能，并增加 Notebook 集成；以下为主要迁移范围：
+
+- [ ] 在 Jupyter 侧边栏配置、管理和切换 DolphinDB 连接。
+- [ ] 创建、编辑 `.dos` 文件，并像选择 Python 内核一样选择执行连接。
+- [ ] 执行文件、选中代码或当前语句，显示运行状态并支持取消执行。
+- [ ] 在 Notebook 中编写和执行 DDB 代码，提供类似 SQL 的使用体验。
+- [ ] 语法高亮、代码补全、内置函数文档和参数提示。
+- [ ] 显示执行结果、`print()` 输出和错误信息。
+- [ ] 浏览数据库、表和会话变量，展示表、向量及矩阵，并导出 CSV。
+- [ ] 调试等其余能力按上游功能清单逐项迁移和验收。
+
+计划面向 JupyterLab 4 和 Jupyter Notebook 7；前端扩展、服务端连接执行层及
+Notebook 集成会在后续开发阶段加入。
+
+## 安装骨架版本
+
+需要 Python 3.10 或更高版本。
+
+```shell
+pip install dolphindb-extension==0.1.0a1
+```
+
+包的 Python 导入名称为 `dolphindb_extension`：
+
+```python
+from dolphindb_extension import __version__
+
+print(__version__)
+```
+
+## 本地开发
+
+使用 [uv](https://docs.astral.sh/uv/) 管理 Python 环境、锁文件和构建。
+开发环境固定为 Python 3.12，运行时最低支持 Python 3.10。
+
+```shell
+git clone https://github.com/realhuhu/dolphindb-extension.git
+cd dolphindb-extension
+uv sync --locked
+uv run python -c "import dolphindb_extension; print(dolphindb_extension.__version__)"
+uv build --no-sources
+uvx twine check --strict dist/*
+```
+
+源码位于 `src/dolphindb_extension/`，构建配置位于 `pyproject.toml`，
+wheel 和源码分发包输出到 `dist/`。当前包没有运行时依赖。
+GitHub Actions 会检查锁文件、构建产物和独立安装后的导入。
+
+## 发布
+
+更新 `pyproject.toml` 中的版本和 `CHANGELOG.md`，运行 `uv lock`，并在干净的
+`dist/` 目录中重新构建和检查产物。提交代码并创建对应版本的 Git 标签后发布。
+
+```shell
+uv auth login https://upload.pypi.org --username __token__
+uv publish
+```
+
+登录时在交互提示中输入 PyPI API token。凭据保存在 uv 的本机凭据存储中，
+不应写入源码、提交记录或构建产物。
+
+## 许可证
+
+采用 [Apache License 2.0](LICENSE)。本项目以 DolphinDB VS Code 插件为迁移参考；
+初始版本尚未包含迁移后的上游实现。

dolphindb_extension-0.1.0a1/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "dolphindb-extension"
+version = "0.1.0a1"
+description = "DolphinDB integration for JupyterLab and Jupyter Notebook (initial scaffold)."
+readme = "README.md"
+authors = [
+    { name = "realhuhu", email = "2661467107@qq.com" }
+]
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+keywords = ["dolphindb", "ddb", "jupyter", "jupyterlab", "notebook"]
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "Framework :: Jupyter",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Database :: Front-Ends",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/realhuhu/dolphindb-extension"
+Repository = "https://github.com/realhuhu/dolphindb-extension"
+Issues = "https://github.com/realhuhu/dolphindb-extension/issues"
+Changelog = "https://github.com/realhuhu/dolphindb-extension/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling>=1.27,<2"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dolphindb_extension"]

dolphindb_extension-0.1.0a1/src/dolphindb_extension/__init__.py

@@ -0,0 +1,5 @@
+"""Initial package scaffold for the DolphinDB Jupyter extension."""
+
+from importlib.metadata import version
+
+__version__ = version("dolphindb-extension")

dolphindb_extension-0.1.0a1/uv.lock

@@ -0,0 +1,8 @@
+version = 1
+revision = 3
+requires-python = ">=3.10"
+
+[[package]]
+name = "dolphindb-extension"
+version = "0.1.0a1"
+source = { editable = "." }