Skip to content

Added scripts that feed the gurubase.io RAG AI tool#307

Merged
amilcarlucas merged 1 commit into
masterfrom
crawl_scripts
Apr 21, 2025
Merged

Added scripts that feed the gurubase.io RAG AI tool#307
amilcarlucas merged 1 commit into
masterfrom
crawl_scripts

Conversation

@amilcarlucas
Copy link
Copy Markdown
Collaborator

@amilcarlucas amilcarlucas commented Mar 24, 2025

This pull request introduces several updates, including dependency adjustments, project configuration changes, and the addition of new scripts for crawling ArduPilot-related documentation and GitHub repositories. The most notable changes focus on enhancing functionality for documentation processing and ensuring proper dependency management.

Dependency and Configuration Updates:

  • Updated the pylint workflow to install the scripts dependency group in addition to dev for improved compatibility with new scripts. (.github/workflows/pylint.yml, .github/workflows/pylint.ymlL43-R43)
  • Added a new scripts dependency group in pyproject.toml, which includes the bs4 package for HTML parsing. (pyproject.toml, pyproject.tomlR78-R81)

New Scripts for Documentation Crawling:

  • Added scripts/crawl_ardupilot_wiki.py, a Python script for crawling ArduPilot documentation pages. It includes functionality for handling proxies, filtering URLs, and removing duplicates. (scripts/crawl_ardupilot_wiki.py, scripts/crawl_ardupilot_wiki.pyR1-R239)
  • Added scripts/crawl_github_ardupilot.sh, a Bash script for finding and listing URLs of README.md files in the ArduPilot GitHub repository. (scripts/crawl_github_ardupilot.sh, scripts/crawl_github_ardupilot.shR1-R14)

@amilcarlucas amilcarlucas requested a review from Copilot March 24, 2025 18:17
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 24, 2025

Test Results

    2 files      2 suites   1m 48s ⏱️
  565 tests   564 ✅ 1 💤 0 ❌
1 130 runs  1 128 ✅ 2 💤 0 ❌

Results for commit bb6834a.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 24, 2025

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
6134 4027 66% 60% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: fe0f962 by action🐍

@amilcarlucas amilcarlucas force-pushed the crawl_scripts branch 3 times, most recently from 3fc8d08 to bb6834a Compare March 24, 2025 19:30
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds new scripts for crawling ArduPilot-related documentation and GitHub repositories while updating dependency configurations and the pylint workflow to support the newly added functionality.

  • New Python and Bash scripts for crawling documentation pages and GitHub repositories
  • Updated dependency groups in pyproject.toml
  • Adjusted the pylint workflow to install the additional “scripts” dependency

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File Description
scripts/crawl_ardupilot_wiki.py Introduces a Python crawler with URL deduplication and proxy support
pyproject.toml Adds a new dependency group for scripts
.github/workflows/pylint.yml Adjusts dependency installation command to include the scripts group
Files not reviewed (1)
  • scripts/crawl_github_ardupilot.sh: Language not supported
Comments suppressed due to low confidence (2)

scripts/crawl_ardupilot_wiki.py:95

  • [nitpick] The logic for de-duplicating URLs ending with '/index.html' could benefit from an inline comment to clarify its intent or a refactor into a helper function, which would improve readability.
if url.endswith("/index.html") and (url[:-11] in visited_urls or url[:-10] in visited_urls):

.github/workflows/pylint.yml:43

  • The command prefix 'uv' is unusual for pip commands; please verify that 'uv pip install' is the intended command alias in this workflow.
uv pip install .[dev,scripts]

Comment thread scripts/crawl_ardupilot_wiki.py
@amilcarlucas amilcarlucas merged commit ef56e22 into master Apr 21, 2025
26 of 28 checks passed
@amilcarlucas amilcarlucas deleted the crawl_scripts branch April 21, 2025 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants