From affd2a7380cd9edc595cd6f01fc4ee9a80d334fb Mon Sep 17 00:00:00 2001 From: HungKNguyen Date: Fri, 22 Aug 2025 11:51:18 +0700 Subject: [PATCH] fix: fix AI scripting for documentation --- .gitignore | 1 + README.md | 2 +- context7.json | 3 +-- pyproject.toml | 16 ++++++++-------- .../nutrient_dws_scripts/LLM_DOC.md | 0 .../__init__.py | 0 .../add_claude_code_rule.py | 2 +- .../add_cursor_rule.py | 2 +- .../add_github_copilot_rule.py | 2 +- .../add_junie_rule.py | 2 +- .../add_windsurf_rule.py | 2 +- 11 files changed, 16 insertions(+), 16 deletions(-) rename LLM_DOC.md => src/nutrient_dws_scripts/LLM_DOC.md (100%) rename src/{scripts => nutrient_dws_scripts}/__init__.py (100%) rename src/{scripts => nutrient_dws_scripts}/add_claude_code_rule.py (93%) rename src/{scripts => nutrient_dws_scripts}/add_cursor_rule.py (94%) rename src/{scripts => nutrient_dws_scripts}/add_github_copilot_rule.py (94%) rename src/{scripts => nutrient_dws_scripts}/add_junie_rule.py (94%) rename src/{scripts => nutrient_dws_scripts}/add_windsurf_rule.py (94%) diff --git a/.gitignore b/.gitignore index 0e553f9..4715efc 100644 --- a/.gitignore +++ b/.gitignore @@ -156,3 +156,4 @@ openapi_spec.yml # Example output examples/output +/examples/example_venv/ diff --git a/README.md b/README.md index b12a086..edb7b8c 100644 --- a/README.md +++ b/README.md @@ -234,7 +234,7 @@ src/ │ ├── inputs.py # Input handling │ ├── workflow.py # Workflow factory │ └── __init__.py # Public exports -├── scripts/ # CLI scripts for coding agents +├── nutrient_dws_scripts/ # CLI scripts for coding agents └── tests/ # Test files ``` diff --git a/context7.json b/context7.json index 20e8d2e..064d3d3 100644 --- a/context7.json +++ b/context7.json @@ -2,6 +2,5 @@ "$schema": "https://context7.com/schema/context7.json", "projectTitle": "Nutrient DWS Python Client", "description": "Python client library for Nutrient Document Web Services (DWS) API.\n", - "excludeFolders": ["src", "docs", "example", ".github"], - "excludeFiles": ["README.md"] + "folders": ["src/nutrient_dws_scripts"] } diff --git a/pyproject.toml b/pyproject.toml index fe461e5..507caaa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,9 +11,9 @@ where = ["src"] [tool.setuptools.package-data] nutrient_dws = [ "py.typed", - "../../docs/WORKFLOW.md", - "../../docs/METHODS.md", - "../../LLM_DOC.md", +] +nutrient_dws_scripts = [ + "LLM_DOC.md" ] [project] @@ -65,11 +65,11 @@ Repository = "https://github.com/PSPDFKit/nutrient-dws-client-python" "Bug Tracker" = "https://github.com/PSPDFKit/nutrient-dws-client-python/issues" [project.scripts] -dws-add-claude-code-rule = "scripts.add_claude_code_rule:main" -dws-add-cursor-rule = "scripts.add_cursor_rule:main" -dws-add-github-copilot-rule = "scripts.add_github_copilot_rule:main" -dws-add-junie-rule = "scripts.add_junie_rule:main" -dws-add-windsurf-rule = "scripts.add_windsurf_rule:main" +dws-add-claude-code-rule = "nutrient_dws_scripts.add_claude_code_rule:main" +dws-add-cursor-rule = "nutrient_dws_scripts.add_cursor_rule:main" +dws-add-github-copilot-rule = "nutrient_dws_scripts.add_github_copilot_rule:main" +dws-add-junie-rule = "nutrient_dws_scripts.add_junie_rule:main" +dws-add-windsurf-rule = "nutrient_dws_scripts.add_windsurf_rule:main" [tool.ruff] target-version = "py310" diff --git a/LLM_DOC.md b/src/nutrient_dws_scripts/LLM_DOC.md similarity index 100% rename from LLM_DOC.md rename to src/nutrient_dws_scripts/LLM_DOC.md diff --git a/src/scripts/__init__.py b/src/nutrient_dws_scripts/__init__.py similarity index 100% rename from src/scripts/__init__.py rename to src/nutrient_dws_scripts/__init__.py diff --git a/src/scripts/add_claude_code_rule.py b/src/nutrient_dws_scripts/add_claude_code_rule.py similarity index 93% rename from src/scripts/add_claude_code_rule.py rename to src/nutrient_dws_scripts/add_claude_code_rule.py index 830322f..57aaa76 100644 --- a/src/scripts/add_claude_code_rule.py +++ b/src/nutrient_dws_scripts/add_claude_code_rule.py @@ -4,7 +4,7 @@ def main() -> None: script_dir = os.path.dirname(os.path.abspath(__file__)) - doc_path = os.path.join(script_dir, "..", "..", "LLM_DOC.md") + doc_path = os.path.join(script_dir, "LLM_DOC.md") user_project_root = os.getcwd() output_file = os.path.join(user_project_root, "CLAUDE.md") diff --git a/src/scripts/add_cursor_rule.py b/src/nutrient_dws_scripts/add_cursor_rule.py similarity index 94% rename from src/scripts/add_cursor_rule.py rename to src/nutrient_dws_scripts/add_cursor_rule.py index 3e0001b..ccfe133 100644 --- a/src/scripts/add_cursor_rule.py +++ b/src/nutrient_dws_scripts/add_cursor_rule.py @@ -4,7 +4,7 @@ def main() -> None: script_dir = os.path.dirname(os.path.abspath(__file__)) - doc_path = os.path.join(script_dir, "..", "..", "LLM_DOC.md") + doc_path = os.path.join(script_dir, "LLM_DOC.md") with open(doc_path, encoding="utf-8") as file: documentation = file.read() diff --git a/src/scripts/add_github_copilot_rule.py b/src/nutrient_dws_scripts/add_github_copilot_rule.py similarity index 94% rename from src/scripts/add_github_copilot_rule.py rename to src/nutrient_dws_scripts/add_github_copilot_rule.py index c5060a1..c3f8cde 100644 --- a/src/scripts/add_github_copilot_rule.py +++ b/src/nutrient_dws_scripts/add_github_copilot_rule.py @@ -4,7 +4,7 @@ def main() -> None: script_dir = os.path.dirname(os.path.abspath(__file__)) - doc_path = os.path.join(script_dir, "..", "..", "LLM_DOC.md") + doc_path = os.path.join(script_dir, "LLM_DOC.md") user_project_root = os.getcwd() output_directory = os.path.join(user_project_root, ".github") diff --git a/src/scripts/add_junie_rule.py b/src/nutrient_dws_scripts/add_junie_rule.py similarity index 94% rename from src/scripts/add_junie_rule.py rename to src/nutrient_dws_scripts/add_junie_rule.py index cfeaa8a..b28e0b2 100644 --- a/src/scripts/add_junie_rule.py +++ b/src/nutrient_dws_scripts/add_junie_rule.py @@ -4,7 +4,7 @@ def main() -> None: script_dir = os.path.dirname(os.path.abspath(__file__)) - doc_path = os.path.join(script_dir, "..", "..", "LLM_DOC.md") + doc_path = os.path.join(script_dir, "LLM_DOC.md") user_project_root = os.getcwd() output_directory = os.path.join(user_project_root, ".junie") diff --git a/src/scripts/add_windsurf_rule.py b/src/nutrient_dws_scripts/add_windsurf_rule.py similarity index 94% rename from src/scripts/add_windsurf_rule.py rename to src/nutrient_dws_scripts/add_windsurf_rule.py index 5cd4554..caf4a9a 100644 --- a/src/scripts/add_windsurf_rule.py +++ b/src/nutrient_dws_scripts/add_windsurf_rule.py @@ -4,7 +4,7 @@ def main() -> None: script_dir = os.path.dirname(os.path.abspath(__file__)) - doc_path = os.path.join(script_dir, "..", "..", "LLM_DOC.md") + doc_path = os.path.join(script_dir, "LLM_DOC.md") with open(doc_path, encoding="utf-8") as file: documentation = file.read()