neomatrix369 / learning-path-index

A repo with data files, assets and code supporting and powering the Learning Path Index Project
MIT License
15 stars 16 forks source link

Google Cloud Skills Boost README update #106

Open TobeTek opened 1 week ago

TobeTek commented 1 week ago

Summary by Sourcery

Enhance the documentation for both the Google Cloud Skills Boost scraper and the LLM POC variant to include Windows-specific setup instructions and requirements. Refactor the models.py file to improve type annotations for the Activity class.

Enhancements:

Documentation:

sourcery-ai[bot] commented 1 week ago

Reviewer's Guide by Sourcery

This pull request updates the README files for Google Cloud Skills Boost and LLM-POC-Variant-01, as well as makes a minor change to a model file. The changes primarily focus on improving documentation, adding Windows-specific instructions, and fixing some import and type annotation issues.

Class diagram for the updated Activity model

classDiagram
    class Activity {
        id: str
        href: Optional[str]
        duration: Union[int, float]
        title: str
        type: str
    }

File-Level Changes

Change Details Files
Update Google Cloud Skills Boost README with Windows-specific instructions and correct module paths
  • Add Windows-specific activation command for virtual environment
  • Include instructions to change to the appropriate directory
  • Update module paths for running different scrapers
  • Remove reference to modifying config.py file
app/course-scraper/src/scrapers/google_cloud_skill_boost/README.md
Enhance LLM-POC-Variant-01 README with Windows-specific requirements and setup instructions
  • Add requirement for Microsoft Visual C++ 14.0 or greater on Windows
  • Include instructions for downloading and installing Microsoft Visual C++ on Windows
  • Add steps to set OLLAMA_HOST environment variable on Windows
  • Update known issues section with more specific information
  • Fix minor formatting and typos
app/llm-poc-variant-01/README.md
Update type annotation in Google Cloud Skill Boost models file
  • Replace Python 3.10+ union type syntax with typing.Union for better compatibility
  • Add import for typing.Union
app/course-scraper/src/scrapers/google_cloud_skill_boost/models.py

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).