feat(spider-py): Add boilerplate for spider-py; Add build and lint tasks for spider-py.

README.md

@@ -8,6 +8,7 @@ Follow the steps below to develop and contribute to the project.
 ## Requirements
 * Python 3.10 or higher
 * [Task] 3.40.0 or higher
+* [uv] 0.7.0 or higher
 
 ## Set up
 Run dependency installation task:
@@ -67,3 +68,4 @@ in the table below.
 
 [spider-docs]: https://docs.yscope.com/spider/main/
 [Task]: https://taskfile.dev
+[uv]: https://docs.astral.sh/uv/

build-tasks.yaml

@@ -19,3 +19,7 @@ tasks:
     deps: [":config-cmake-project"]
     cmds:
       - "cmake --build {{.G_BUILD_SPIDER_DIR}} --target clean --parallel {{numCPU}}"
+
+  spider-py:
+    cmds:
+      - "uv build --directory {{.G_SRC_PYTHON_DIR}} -o {{.G_BUILD_PYTHON_DIR}}"

lint-tasks.yaml

@@ -115,12 +115,14 @@ tasks:
       - task: "py"
         vars:
           RUFF_FORMAT_FLAGS: "--diff"
+      - task: "spider-py-check"
 
   py-fix:
     cmds:
       - task: "py"
         vars:
           RUFF_CHECK_FLAGS: "--fix"
+      - task: "spider-py-fix"
 
   py:
     internal: true
@@ -137,6 +139,30 @@ tasks:
           ruff check {{.RUFF_CHECK_FLAGS}} "{{.ITEM}}"
           ruff format {{.RUFF_FORMAT_FLAGS}} "{{.ITEM}}"
 
+  spider-py-check:
+    cmds:
+      - task: "spider-py"
+        vars:
+          RUFF_FORMAT_FLAGS: "--diff"
+
+  spider-py-fix:
+    cmds:
+      - task: "spider-py"
+        vars:
+          RUFF_CHECK_FLAGS: "--fix"
+
+  spider-py:
+    internal: true
+    vars:
+      RUFF_CHECK_FLAGS: "{{.RUFF_CHECK_FLAGS | default \"\"}}"
+      RUFF_FORMAT_FLAGS: "{{.RUFF_FORMAT_FLAGS | default \"\"}}"
+    cmds:
+      - cmd: |-
+          cd "{{.G_SRC_PYTHON_DIR}}"
+          uv run mypy .
+          uv run ruff check {{.RUFF_CHECK_FLAGS}}
+          uv run ruff format {{.RUFF_FORMAT_FLAGS}}
+
   yml:
     aliases:
       - "yml-check"

python/spider-py/.python-version

@@ -0,0 +1 @@
+3.13

python/spider-py/README.md

@@ -0,0 +1,41 @@
+# spider-py
+
+This project is a Python package that provides access to Spider, a distributed task execution
+framework, enabling seamless integration and task management in Python applications.
+
+## Building/Packing
+
+To manually build a package for distribution, follow the steps below.
+
+### Requirements
+
+* [Task] >= 3.40.0
+* [uv] >= 0.7.0
+
+### Build Commands
+
+* Build a Python wheel:
+
+```shell
+task build:spider-py
+```
+
+The command above will generate both a `.tar.gz` and a `.whl` package in the `build/spider-py`
+directory at the Spider project root.
+
+## Linting
+
+To run all linting checks:
+
+```shell
+task lint:spider-py-check
+```
+
+To run all linting checks AND automatically fix any fixable issues:
+
+```shell
+task lint:spider-py-fix
+```
+
+[Task]: https://taskfile.dev
+[uv]: https://docs.astral.sh/uv/

python/spider-py/pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "spider-py"
+version = "0.0.1"
+description = "A distributed task execution framework."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+  { name = "Sitao Wang", email = "sitao.wang@yscope.com" },
+  { name = "Zhihao Lin", email = "lin.zhihao@yscope.com" },
+]
+dependencies = [
+  "mariadb>=1.1.13",
+  "msgpack-types>=0.5.0",
+]
+
+[project.scripts]
+spider_task_executor = "spider_py.task_executor.task_executor:main"
+
+[dependency-groups]
+dev = [
+  "mypy>=1.12.0",
+  "ruff>=0.4.4",
+]
+
+[build-system]
+requires = ["hatchling>=1.18.0"]
+build-backend = "hatchling.build"
+
+[tool.mypy]
+strict = true
+# Additional output
+pretty = true
+show_error_code_links = true
+show_error_context = true
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = 100
+
+[tool.ruff.lint]
+select = ["ALL"]
+extend-select = ["PT"]
+ignore = [
+  "COM812",  # Redundant and conflicts with ruff format
+  "D203",  # No blank line before docstrings (D211)
+  "D205",  # Breaks if summary is larger than one line due to wrapping or if no summary exists
+  "D212",  # Enforce docstring summary line on the next line after quotes (D213)
+  "D400",  # First line of docstrings may not end in period
+  "D401",  # Docstrings should be written in present tense (not imperative)
+  "D415",  # First line of docstrings may not end in a period, question mark, or exclamation point
+  "FA102",  # Allow use of PEP 604 union in type annotations
+  "FBT",  # Allow bool positional parameters since other value positions are allowed
+  "FIX002",  # Allow todo statements
+  "PERF401",  # Allow for loops when creating lists
+  "PERF403",  # Allow for loops when creating dicts
+  "S311",  # Allow usage of `random` package
+  "SIM102",  # Allow collapsible if statements for readability
+  "TD002",  # Author unnecessary for todo statement
+  "TD003",  # Issue link unnecessary for todo statement
+  "UP015",  # Explicit open modes are helpful
+]
+isort.order-by-type = false

python/spider-py/src/spider_py/__init__.py

@@ -0,0 +1 @@
+"""Spider package root."""

python/spider-py/src/spider_py/client/__init__.py

@@ -0,0 +1 @@
+"""Spider python client."""

python/spider-py/src/spider_py/core/__init__.py

@@ -0,0 +1 @@
+"""Spider core package."""

python/spider-py/src/spider_py/core/task.py

@@ -0,0 +1,5 @@
+"""Task module for Spider."""
+
+
+class Task:
+    """Represents a task in Spider."""

python/spider-py/src/spider_py/task_executor/__init__.py

@@ -0,0 +1 @@
+"""Python task executor for running Python task function."""

python/spider-py/src/spider_py/task_executor/task_executor.py

@@ -0,0 +1,9 @@
+"""Executes a Spider Python task."""
+
+
+def main() -> None:
+    """Main function to execute the task."""
+
+
+if __name__ == "__main__":
+    main()