fix: move the workflows folder under correct place

.github/workflows/main.yml

@@ -0,0 +1,31 @@
+name: Basic PR Quality Checks
+
+on:
+  pull_request:
+    branches: [ "main", "dev" ]
+    types:
+      - opened
+      - edited
+      - reopened
+      - synchronize
+
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+  checks: write
+
+jobs:
+  quality-checks:
+    name: Run Organization Quality Checks
+    uses: sessatakuma/org-workflows/.github/workflows/entrypoint.yml@main
+    secrets:
+      CHECKER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    with:
+      # Basic PR Quality Checks (enabled by default)
+      run-basic-checks: true
+
+      # Python Code Quality Checks (optional - uncomment to enable)
+      # Requires: pyproject.toml with ruff and mypy configured
+      run-python-checks: true
+      python-version: '3.11'

.gitignore

@@ -1,3 +1,4 @@
 .venv
 __pycache__/
-secret.yaml
+secret.yaml
+.pre-commit-config.yaml

README.md

@@ -1,7 +1,7 @@
 # API-tools
 
 > [!WARNING]
-> 
+>
 > This project is still under development!
 
 This is a repository that implement several API interfaces for Discord BOT and web interface.
@@ -14,7 +14,7 @@ Currently we have 2 implemented APIs
 5. Sentence Query API
 
 > [!NOTE]
-> 
+>
 > The following document is only for developer, we will use Swagger UI to generate official API document.
 
 1. Mark Accent
@@ -24,7 +24,7 @@ Currently we have 2 implemented APIs
 
         `https://{TODO}/api/MarkAccent/`
     - **Request Parameter (POST)**
-        
+
         > Note that we only accept POST request
 
         |    Parameter    |  Type  |  Explanation |
@@ -40,7 +40,7 @@ Currently we have 2 implemented APIs
         ```
 
     - **Respond Parameter**
-        
+
         |    Parameter    |  Type  |  Explanation |
         | --------------- | ------ | ------------ |
         |      status     |  int   | status code [Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#server_error_responses) |
@@ -136,7 +136,7 @@ Currently we have 2 implemented APIs
 
         `https://{TODO}/api/MarkFurigana/`
     - **Request Parameter (POST)**
-        
+
         > Note that we only accept POST request
 
         |    Parameter    |  Type  |  Explanation |
@@ -150,7 +150,7 @@ Currently we have 2 implemented APIs
             "text": "漢字かな交じり文"
         }
         ```
-    
+
     - **Respond Parameter**
 
         |    Parameter    |  Type  |  Explanation |
@@ -249,4 +249,15 @@ async def foo(
         ...
     except httpx.HTTPError as e:
         ...
-```
+```
+
+
+## Check the project
+Since the package of ruff and mypy are already installed in dev group,
+one can directly execute the following command to format and check the project:
+```bash
+ruff format . --check # Check format
+ruff check .          # Check linter
+mypy .                # Check type
+```
+For more detailed setting with IDE (e.g. VScode), please refer to our manul.

pyproject.toml

@@ -15,3 +15,27 @@ dependencies = [
     "requests>=2.32.5",
     "uvicorn>=0.38.0",
 ]
+
+[dependency-groups]
+dev = [
+    "mypy>=1.18.2",
+    "pyyaml>=6.0.3",
+    "ruff>=0.14.2",
+    "toml>=0.10.2",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "F", "N"]
+
+[tool.mypy]
+strict = true
+namespace_packages = true
+warn_unused_ignores = false
+ignore_missing_imports = true