update documentation

Author: HungKNguyen

.github/workflows/ci.yml

@@ -27,8 +27,8 @@ jobs:
 
     - name: Run linting
       run: |
-        python -m ruff check .
-        python -m ruff format --check .
+        python -m ruff check src/
+        python -m ruff format --check src/
 
     - name: Run type checking
       run: python -m mypy src/

.gitignore

@@ -155,4 +155,4 @@ openapi_spec.yml
 .claude/settings.local.json
 
 # Integration test configuration
-src/tests/integration/integration_config.py
+tests/integration/integration_config.py

.pre-commit-config.yaml

@@ -18,11 +18,13 @@ repos:
     hooks:
       - id: ruff
         args: [--fix]
+        files: ^src
       - id: ruff-format
+        files: ^src
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.17.1
     hooks:
       - id: mypy
         additional_dependencies: [types-aiofiles, httpx]
-        files: ^src/nutrient_dws
+        files: ^src

pyproject.toml

@@ -111,7 +111,7 @@ ignore = [
 convention = "google"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = ["D", "S101"]  # Don't require docstrings in tests, allow asserts
+"tests/*" = []  # Don't require docstrings in tests, allow asserts
 
 [tool.mypy]
 python_version = "3.10"

pytest.ini

@@ -3,4 +3,5 @@ testpaths = tests
 python_files = test_*.py
 python_classes = Test*
 python_functions = test_*
-addopts = -ra
+addopts = -ra --tb=short
+asyncio_mode = auto

src/scripts/add_claude_code_rule.py

@@ -2,7 +2,7 @@
 import sys
 
 
-def main():
+def main() -> None:
     script_dir = os.path.dirname(os.path.abspath(__file__))
     doc_path = os.path.join(script_dir, "..", "LLM_DOC.md")
     type_path = os.path.join(script_dir, "..", "dist", "__init__.pyi")

src/scripts/add_cursor_rule.py

@@ -2,7 +2,7 @@
 import sys
 
 
-def main():
+def main() -> None:
     script_dir = os.path.dirname(os.path.abspath(__file__))
     doc_path = os.path.join(script_dir, "..", "LLM_DOC.md")
     with open(doc_path, encoding="utf-8") as file:
@@ -31,7 +31,9 @@ def main():
         with open(output_file, "a", encoding="utf-8") as f:
             f.write(rule)
 
-        print(f"📄 Updated Cursor Rules to point to Nutrient DWS documentation at {output_file}.")
+        print(
+            f"📄 Updated Cursor Rules to point to Nutrient DWS documentation at {output_file}."
+        )
     except Exception as err:
         print(f"Failed to update Cursor Rule: {err}", file=sys.stderr)
         sys.exit(1)

src/scripts/add_github_copilot_rule.py

@@ -2,7 +2,7 @@
 import sys
 
 
-def main():
+def main() -> None:
     script_dir = os.path.dirname(os.path.abspath(__file__))
     doc_path = os.path.join(script_dir, "..", "LLM_DOC.md")
     type_path = os.path.join(script_dir, "..", "dist", "__init__.pyi")
@@ -30,5 +30,8 @@ def main():
             f"📄 Updated GitHub Copilot Rules to point to Nutrient DWS documentation at {relative_doc_path} and {relative_type_path}."
         )
     except Exception as err:
-        print(f"Failed to update .github/copilot-instructions.md file: {err}", file=sys.stderr)
+        print(
+            f"Failed to update .github/copilot-instructions.md file: {err}",
+            file=sys.stderr,
+        )
         sys.exit(1)

src/scripts/add_junie_rule.py

@@ -2,7 +2,7 @@
 import sys
 
 
-def main():
+def main() -> None:
     script_dir = os.path.dirname(os.path.abspath(__file__))
     doc_path = os.path.join(script_dir, "..", "LLM_DOC.md")
     type_path = os.path.join(script_dir, "..", "dist", "__init__.pyi")

src/scripts/add_windsurf_rule.py

@@ -2,7 +2,7 @@
 import sys
 
 
-def main():
+def main() -> None:
     script_dir = os.path.dirname(os.path.abspath(__file__))
     doc_path = os.path.join(script_dir, "..", "LLM_DOC.md")
     with open(doc_path, encoding="utf-8") as file:
@@ -30,7 +30,9 @@ def main():
         with open(output_file, "a", encoding="utf-8") as f:
             f.write(rule)
 
-        print(f"📄 Updated Windsurf Rules to point to Nutrient DWS documentation at {output_file}.")
+        print(
+            f"📄 Updated Windsurf Rules to point to Nutrient DWS documentation at {output_file}."
+        )
     except Exception as err:
         print(f"Failed to update Windsurf Rule: {err}", file=sys.stderr)
         sys.exit(1)