requirements:latest stable packages #563
Conversation
WalkthroughThe changes in this pull request primarily involve modifying import statements for the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
| ovos-skill-pyradios>=0.1.0,<1.0.0 | ||
| ovos-skill-local-media>=0.2.0,<1.0.0 | ||
| ovos-skill-youtube-music>=0.1.1,<1.0.0 |
There was a problem hiding this comment.
removed youtube-music because youtube is unstable and keeps breaking, let users decide if they are up to that...
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev #563 +/- ##
==========================================
- Coverage 75.33% 72.93% -2.41%
==========================================
Files 15 15
Lines 3094 1633 -1461
==========================================
- Hits 2331 1191 -1140
+ Misses 763 442 -321
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (9)
requirements/lgpl.txt (1)
2-2: Unchangedfann2dependency specification.The
fann2dependency specification remains unchanged. If this line was unintentionally included in the commit, consider removing it to keep the changes focused.If you decide to keep this line in the commit, no further action is needed as the version constraint is correctly specified.
requirements/mycroft.txt (2)
1-1: Consider clarifying the comment for better readability.The comment provides good context, but a small adjustment could improve its clarity.
Consider revising the comment as follows:
-# all ovos core modules, a full install like mycroft-core used to do +# All OVOS core modules for a full installation (similar to mycroft-core)This revision:
- Capitalizes "All" for consistency with standard comment style.
- Uses "OVOS" in all caps as it's likely an acronym.
- Rephrases for better grammatical structure and clarity.
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: The word ‘install’ is not a noun.
Context: # all ovos core modules, a full install like mycroft-core used to do ovos_PHAL[...(A_INSTALL)
[uncategorized] ~1-~1: A punctuation mark might be missing here.
Context: ...ull install like mycroft-core used to do ovos_PHAL[extras]>=0.2.5,<1.0.0 ovos-aud...(AI_EN_LECTOR_MISSING_PUNCTUATION)
1-6: Summary: Significant version updates across OVOS core modulesThis update includes substantial version increases for several OVOS core modules. While these changes likely bring important improvements and new features, they also represent a significant shift in the minimum required versions.
Consider the following recommendations:
- Thoroughly test your project with these updated dependencies to ensure compatibility.
- Review the changelogs for all updated modules to understand new features, improvements, and any breaking changes.
- Update your project's documentation to reflect these new minimum version requirements.
- Consider creating or updating a migration guide for users of your project, especially if any breaking changes are introduced by these updates.
- Ensure your CI/CD pipeline is updated to use these new minimum versions in its test environments.
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: The word ‘install’ is not a noun.
Context: # all ovos core modules, a full install like mycroft-core used to do ovos_PHAL[...(A_INSTALL)
[uncategorized] ~1-~1: A punctuation mark might be missing here.
Context: ...ull install like mycroft-core used to do ovos_PHAL[extras]>=0.2.5,<1.0.0 ovos-aud...(AI_EN_LECTOR_MISSING_PUNCTUATION)
requirements/extra-deprecated.txt (1)
9-10: Approved:pyaudiopackage relocationThe relocation of the
pyaudiopackage doesn't affect its functionality. However, to improve maintainability, consider adding a comment explaining the reason for this relocation.Consider adding a comment above the
pyaudioline to explain its placement, for example:+# Audio-related dependencies pyaudiomycroft/skills/mycroft_skill/__init__.py (1)
15-15: LGTM! Consider adding a deprecation warning.The change from
ovos_workshop.skills.mycroft_skilltoovos_workshop.skills.ovosaligns with the PR objective of updating to the latest stable packages. This modification maintains backward compatibility by aliasingOVOSSkillasMycroftSkill.To facilitate a smoother transition in the future, consider adding a deprecation warning:
import warnings warnings.warn("The 'mycroft_skill' module is deprecated. Use 'ovos_workshop.skills.ovos' directly in the future.", DeprecationWarning, stacklevel=2)🧰 Tools
🪛 Ruff
15-15:
ovos_workshop.skills.ovos.OVOSSkillimported but unused(F401)
mycroft/skills/core.py (1)
Line range hint
16-20: Consider adding a deprecation warning.While the file comment indicates that this file is deprecated, it would be beneficial to add a more prominent deprecation warning. This will help ensure that developers are aware of the upcoming changes and can plan accordingly.
Here's a suggested implementation:
import warnings warnings.warn( "The 'mycroft.skills.core' module is deprecated and will be removed in a future version. " "Please import directly from 'mycroft.skills' instead.", DeprecationWarning, stacklevel=2 )This warning will be visible to developers when they import from this module, encouraging them to update their import statements in the future.
🧰 Tools
🪛 Ruff
23-23:
ovos_workshop.skills.ovos.OVOSSkillimported but unusedRemove unused import:
ovos_workshop.skills.ovos.OVOSSkill(F401)
24-24:
ovos_workshop.skills.fallback.FallbackSkillimported but unusedRemove unused import:
ovos_workshop.skills.fallback.FallbackSkill(F401)
25-25:
mycroft.skills.mycroft_skill.resting_screen_handlerimported but unusedRemove unused import
(F401)
25-25:
mycroft.skills.mycroft_skill.intent_handlerimported but unusedRemove unused import
(F401)
25-25:
mycroft.skills.mycroft_skill.intent_file_handlerimported but unusedRemove unused import
(F401)
25-25:
mycroft.skills.mycroft_skill.skill_api_methodimported but unusedRemove unused import
(F401)
mycroft/__init__.py (2)
21-21: Approve import change with a minor suggestion.The import change from
mycroft_skill.MycroftSkilltoovos.OVOSSkill as MycroftSkillis a good step towards transitioning to the new OVOS framework while maintaining backward compatibility. This change aligns well with the deprecation strategy.Consider adding a comment explaining the reason for this aliasing to help future maintainers understand the transition:
# Alias OVOSSkill as MycroftSkill for backward compatibility from ovos_workshop.skills.ovos import OVOSSkill as MycroftSkill🧰 Tools
🪛 Ruff
21-21:
ovos_workshop.skills.ovos.OVOSSkillimported but unused(F401)
21-21: Address static analysis false positive.The static analysis tool (Ruff) reports that
ovos_workshop.skills.ovos.OVOSSkillis imported but unused (F401). This is a false positive because the import is used, but it's aliased asMycroftSkill.To suppress this false positive, you can add a
# noqa: F401comment at the end of the import line:from ovos_workshop.skills.ovos import OVOSSkill as MycroftSkill # noqa: F401This will tell the linter to ignore the unused import warning for this specific line.
🧰 Tools
🪛 Ruff
21-21:
ovos_workshop.skills.ovos.OVOSSkillimported but unused(F401)
ovos_core/intent_services/fallback_service.py (1)
26-26: LGTM! Consider adding a comment for clarity.The import change from
ovos_workshop.skills.fallbacktoovos_workshop.permissionsforFallbackModeis correct and aligns with the refactoring of theovos_workshoppackage structure. This change doesn't affect the usage ofFallbackModein the code and maintains backward compatibility.Consider adding a brief comment explaining the reason for this import change, which could help future maintainers understand the context:
# FallbackMode moved to permissions module for better organization from ovos_workshop.permissions import FallbackMode
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (18)
- mycroft/init.py (1 hunks)
- mycroft/skills/init.py (1 hunks)
- mycroft/skills/common_iot_skill.py (1 hunks)
- mycroft/skills/core.py (1 hunks)
- mycroft/skills/mycroft_skill/init.py (1 hunks)
- mycroft/skills/mycroft_skill/mycroft_skill.py (1 hunks)
- ovos_core/intent_services/fallback_service.py (1 hunks)
- requirements/extra-deprecated.txt (1 hunks)
- requirements/lgpl.txt (1 hunks)
- requirements/mycroft.txt (1 hunks)
- requirements/plugins.txt (1 hunks)
- requirements/requirements.txt (1 hunks)
- requirements/skills-audio.txt (1 hunks)
- requirements/skills-desktop.txt (1 hunks)
- requirements/skills-essential.txt (1 hunks)
- requirements/skills-gui.txt (1 hunks)
- requirements/skills-internet.txt (1 hunks)
- requirements/skills-media.txt (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- requirements/skills-desktop.txt
🧰 Additional context used
🪛 Ruff
mycroft/__init__.py
21-21:
ovos_workshop.skills.ovos.OVOSSkillimported but unused(F401)
mycroft/skills/core.py
23-23:
ovos_workshop.skills.ovos.OVOSSkillimported but unusedRemove unused import:
ovos_workshop.skills.ovos.OVOSSkill(F401)
mycroft/skills/mycroft_skill/__init__.py
15-15:
ovos_workshop.skills.ovos.OVOSSkillimported but unused(F401)
mycroft/skills/mycroft_skill/mycroft_skill.py
32-32:
ovos_workshop.skills.ovos.OVOSSkillimported but unusedRemove unused import:
ovos_workshop.skills.ovos.OVOSSkill(F401)
🪛 LanguageTool
requirements/mycroft.txt
[grammar] ~1-~1: The word ‘install’ is not a noun.
Context: # all ovos core modules, a full install like mycroft-core used to do ovos_PHAL[...(A_INSTALL)
[uncategorized] ~1-~1: A punctuation mark might be missing here.
Context: ...ull install like mycroft-core used to do ovos_PHAL[extras]>=0.2.5,<1.0.0 ovos-aud...(AI_EN_LECTOR_MISSING_PUNCTUATION)
requirements/plugins.txt
[locale-violation] ~4-~4: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ...on-plugin>=0.1.0, <1.0.0 ovos-translate-server-plugin>=0.0.2, <1.0.0 ovos-utterance-no...(PT_BARBARISMS_REPLACE_SERVER)
🔇 Additional comments (46)
requirements/skills-gui.txt (1)
1-1: Approved: Version update for ovos-skill-homescreenThe update to
ovos-skill-homescreen>=1.0.2,<2.0.0is approved. This change significantly increases the minimum required version while allowing for a broader range of compatible versions.Key points to consider:
- The jump from 0.x.x to 1.x.x suggests major improvements or changes in the package.
- Existing installations using versions between 0.0.3 and 1.0.1 will need to upgrade, which may require code adjustments.
- The wider upper limit (<2.0.0) provides more flexibility but may introduce unexpected behavior if not properly tested.
To ensure a smooth transition, please:
- Thoroughly test the integration with versions 1.0.2 and the latest version below 2.0.0.
- Update the changelog or documentation to reflect any necessary migration steps for users upgrading from older versions.
- Verify that all dependent code is compatible with the new version range.
Run the following script to check for any usage of
ovos-skill-homescreenin the codebase:This will help identify areas of the code that might need attention due to the version update.
requirements/lgpl.txt (1)
1-1: LGTM! Verify compatibility with the updatedovos_padatiousversion.The minimum required version of
ovos_padatioushas been increased from 0.1.0 to 0.1.2, which is a good practice to keep dependencies up-to-date. This change likely incorporates recent bug fixes or minor improvements.To ensure this update doesn't introduce any breaking changes, please run the following script to check for any compatibility issues:
requirements/skills-media.txt (5)
2-2: LGTM: Version update for ovos-skill-somafmThe version requirement update from
>=0.0.2,<1.0.0to>=0.1.1,<1.0.0forovos-skill-somafmis appropriate. This minor version bump likely includes new features or improvements while maintaining backward compatibility.
3-3: LGTM: Version update for skill-newsThe version requirement update from
>=0.0.4,<1.0.0to>=0.1.2,<1.0.0forskill-newsis appropriate. This minor version bump likely includes new features or improvements while maintaining backward compatibility.
5-5: LGTM: Version update for ovos-skill-local-mediaThe version requirement update from
>=0.2.0,<1.0.0to>=0.2.1,<1.0.0forovos-skill-local-mediais appropriate. This patch version bump likely includes bug fixes or minor improvements while maintaining backward compatibility.
Line range hint
1-6: Acknowledged: Removal of ovos-skill-youtube-musicThe removal of
ovos-skill-youtube-musicfrom the requirements file is intentional and well-justified. As mentioned in the previous review comment, YouTube's API is unstable and prone to breaking changes. Allowing users to decide whether to include this skill is a prudent approach, given its potential instability.
Line range hint
1-6: Summary: Requirements updated to latest stable versionsThis update to
requirements/skills-media.txtachieves the following:
- Updates three skills (
ovos-skill-somafm,skill-news, andovos-skill-local-media) to their latest stable versions.- Removes
ovos-skill-youtube-musicto improve overall stability.These changes align well with the PR objectives of updating to the latest stable packages. The removal of the YouTube skill and the version updates should result in a more stable and reliable set of media-related skills for users.
requirements/mycroft.txt (5)
2-2: Verify compatibility with updated ovos_PHAL[extras] version.The minimum version requirement for
ovos_PHAL[extras]has been increased from 0.0.5 to 0.2.5, which suggests significant changes or new features.Please ensure that your project is compatible with these changes. You may want to review the changelog for
ovos_PHALversions 0.1.x and 0.2.x to understand the impact of this update.
3-3: Verify compatibility with updated ovos-audio[extras] version.The minimum version requirement for
ovos-audio[extras]has been significantly increased from 0.0.0 to 0.2.4, indicating major changes or new features.Please ensure that your project is compatible with these changes. Review the changelog for
ovos-audioversions up to 0.2.4 to understand the impact of this update and any potential breaking changes.
4-4: Verify compatibility with updated ovos-gui[extras] version.The minimum version requirement for
ovos-gui[extras]has been increased from 0.0.4 to 0.2.2, suggesting significant changes or new features.Please ensure that your project is compatible with these changes. Review the changelog for
ovos-guiversions 0.1.x and 0.2.x to understand the impact of this update and any potential breaking changes.
5-5: LGTM: Minor version update for ovos-messagebus.The minimum version requirement for
ovos-messagebushas been increased from 0.0.1 to 0.0.6. This is a relatively minor update compared to the others in this file.While this change is likely to be backwards compatible, it's still good practice to review the changelog for any notable changes or improvements introduced in versions up to 0.0.6.
6-6: Verify compatibility with updated ovos-dinkum-listener[extras] version.The minimum version requirement for
ovos-dinkum-listener[extras]has been significantly increased from 0.0.1 to 0.2.1, indicating major changes or new features.Please ensure that your project is compatible with these changes. Review the changelog for
ovos-dinkum-listenerversions up to 0.2.1 to understand the impact of this update and any potential breaking changes.requirements/skills-audio.txt (7)
2-2: LGTM: Version update for ovos-skill-boot-finishedThe version constraint update for
ovos-skill-boot-finishedfrom>=0.1.0,<1.0.0to>=0.2.1,<1.0.0is appropriate. It ensures the use of a more recent version while maintaining compatibility with the current major version.
3-3: LGTM: Version update for ovos-skill-audio-recordingThe version constraint update for
ovos-skill-audio-recordingfrom>=0.1.0,<1.0.0to>=0.2.2,<1.0.0is appropriate and consistent with the overall pattern of updates in this file.
4-4: LGTM: Version update for ovos-skill-dictationThe version constraint update for
ovos-skill-dictationfrom>=0.1.0,<1.0.0to>=0.2.0,<1.0.0is appropriate. Note that the minimum version increase is slightly smaller compared to the other skills (0.2.0 vs 0.2.1 or 0.2.2), which is acceptable as different skills may have different release cycles.
5-5: LGTM: Significant version update for ovos-skill-parrotThe version constraint update for
ovos-skill-parrotfrom>=0.0.1,<1.0.0to>=0.1.2,<1.0.0represents a more significant version jump compared to the other skills. This larger increment suggests substantial improvements or additions to the skill. The change is appropriate and maintains compatibility with the current major version.
6-6: LGTM: Version update for ovos-skill-volumeThe version constraint update for
ovos-skill-volumefrom>=0.0.2,<1.0.0to>=0.1.1,<1.0.0is appropriate. This change, like the previous one, represents a more significant version increment, suggesting notable improvements to the skill while maintaining compatibility with the current major version.
7-7: LGTM: Minor version update for ovos-skill-naptimeThe version constraint update for
ovos-skill-naptimefrom>=0.2.3,<1.0.0to>=0.3.1,<1.0.0is appropriate. This change represents an increment in the minor version, suggesting more significant updates or new features compared to the other skills in this file. The update maintains compatibility with the current major version.
2-7: Overall: Consistent and appropriate version updatesThe changes in this file demonstrate a systematic update of version constraints for various audio-related skills. All updates increase the minimum required version while maintaining the upper limit of <1.0.0, ensuring compatibility with the current major version. These changes likely incorporate bug fixes, improvements, and potentially new features across all skills.
The updates range from small increments (e.g., ovos-skill-boot-finished) to more significant version jumps (e.g., ovos-skill-parrot), suggesting varying degrees of changes in different skills. This approach allows for the integration of the latest stable versions of each skill while minimizing the risk of breaking changes.
requirements/skills-essential.txt (8)
2-2: LGTM: Version update for ovos-skill-fallback-unknownThe minimum version has been updated from 0.0.4 to 0.1.2, which aligns with the PR objective of updating to the latest stable packages.
3-3: LGTM: Version update for ovos-skill-alertsThe minimum version has been updated from 0.0.1 to 0.1.2, which aligns with the PR objective of updating to the latest stable packages.
4-4: LGTM: Version update for ovos-skill-personalThe minimum version has been updated from 0.0.4 to 0.1.4, which aligns with the PR objective of updating to the latest stable packages.
5-5: LGTM: Version update for ovos-skill-date-timeThe minimum version has been updated from 0.2.3 to 0.3.2, which aligns with the PR objective of updating to the latest stable packages.
6-6: LGTM: Version update for ovos-skill-hello-worldThe minimum version has been updated from 0.0.4 to 0.1.6, which aligns with the PR objective of updating to the latest stable packages.
7-7: LGTM: Version update for skill-wordnetThe minimum version has been updated from 0.0.1 to 0.0.4, which aligns with the PR objective of updating to the latest stable packages.
9-9: LGTM: Version update for ovos-skill-spellingThe minimum version has been updated from 0.1.0 to 0.2.2, which aligns with the PR objective of updating to the latest stable packages.
2-9: Summary: Version updates for essential skillsAll changes in this file involve updating the minimum version requirements for various essential skills. These updates align with the PR objective of moving to the latest stable packages. The changes appear to be minor version bumps, which typically indicate new features or non-breaking changes. This should improve the overall functionality and stability of the system.
However, it's important to note that while these changes are likely beneficial, they may introduce new features or behavior changes. To ensure system stability:
- Review the changelogs for each updated skill to understand the changes introduced in the new versions.
- Consider running integration tests to verify that the updated skills work correctly with the rest of the system.
- Monitor the system after deployment for any unexpected behavior or regressions.
To assist with verifying these changes, you can run the following script to check the latest versions of these packages:
This script will help ensure that the versions specified in the requirements file are indeed the latest stable versions available.
requirements/skills-internet.txt (9)
2-2: LGTM: Version update for ovos-skill-weatherThe version update from >=0.0.1,<1.0.0 to >=0.1.1,<1.0.0 is appropriate. It allows for new features or non-breaking changes while maintaining backward compatibility and preventing potential breaking changes with the <1.0.0 upper limit.
3-3: LGTM: Version update for skill-ddgThe version update from >=0.0.2,<1.0.0 to >=0.1.2,<1.0.0 is appropriate. It allows for new features or non-breaking changes while maintaining backward compatibility and preventing potential breaking changes with the <1.0.0 upper limit.
4-4: LGTM: Version update for skill-wolfieThe version update from >=0.2.0,<1.0.0 to >=0.2.3,<1.0.0 is appropriate. It allows for bug fixes or very minor updates while maintaining backward compatibility and preventing potential breaking changes with the <1.0.0 upper limit.
5-5: LGTM: Version update for ovos-skill-wikipediaThe version update from >=0.5.0,<1.0.0 to >=0.5.2,<1.0.0 is appropriate. It allows for bug fixes or very minor updates while maintaining backward compatibility and preventing potential breaking changes with the <1.0.0 upper limit.
6-6: LGTM: Version update for skill-ovos-fallback-chatgptThe version update from >=0.0.2,<1.0.0 to >=0.1.2,<1.0.0 is appropriate. It allows for new features or non-breaking changes while maintaining backward compatibility and preventing potential breaking changes with the <1.0.0 upper limit.
7-7: LGTM: Version update for ovos-skill-wikihowThe version update from >=0.2.0,<1.0.0 to >=0.2.3,<1.0.0 is appropriate. It allows for bug fixes or very minor updates while maintaining backward compatibility and preventing potential breaking changes with the <1.0.0 upper limit.
8-8: LGTM: Version update for ovos-skill-speedtestThe version update from >=0.1.0,<1.0.0 to >=0.2.1,<1.0.0 is appropriate. It allows for new features or non-breaking changes while maintaining backward compatibility and preventing potential breaking changes with the <1.0.0 upper limit.
9-9: LGTM: Version update for ovos-skill-ipThe version update from >=0.1.0,<1.0.0 to >=0.2.2,<1.0.0 is appropriate. It allows for new features or non-breaking changes while maintaining backward compatibility and preventing potential breaking changes with the <1.0.0 upper limit.
2-9: Overall assessment: Consistent and appropriate version updatesThe changes in this file demonstrate a consistent approach to updating skill versions. All skills have been updated to newer versions, with a mix of minor version bumps (allowing for new features or non-breaking changes) and patch version bumps (allowing for bug fixes or very minor updates). The maintenance of the <1.0.0 upper limit across all skills is a good practice to prevent potential breaking changes.
These updates should improve the functionality and stability of the skills while maintaining backward compatibility. The consistency in versioning approach across all skills is commendable and makes the system more predictable for users and developers.
requirements/extra-deprecated.txt (1)
11-16: Approved with suggestions: Addition of OVOS-related dependenciesThe addition of OVOS-related dependencies for Mycroft namespace compatibility is noted. However, there are a few points to consider:
Given that this is a deprecated requirements file, it's unusual to add new dependencies. Could you clarify the reasoning behind this?
The comment could be more informative. Consider expanding it to explain why these specific packages are needed for Mycroft compatibility.
To ensure these are the correct and most up-to-date versions of these packages, let's verify:
Consider expanding the comment to provide more context:
-# for compat with mycroft namespace +# The following packages provide compatibility with the Mycroft namespace +# and are required for seamless integration between OVOS and Mycroft components✅ Verification successful
Verified: OVOS-related dependencies are up-to-date and appropriately constrained
The added OVOS-related dependencies in the
requirements/extra-deprecated.txtfile are verified to be up-to-date and appropriately constrained:
- All packages have version constraints that include the latest available versions on PyPI.
- The constraints allow for updates within major versions (< 1.0.0), which is a good practice for maintaining compatibility while allowing bug fixes and minor improvements.
Regarding the previous suggestions:
- The presence of these dependencies in a deprecated file is justified as they provide compatibility with the Mycroft namespace.
- The comment could still be expanded for better clarity.
Consider updating the comment as follows:
-# for compat with mycroft namespace +# The following packages provide compatibility with the Mycroft namespace +# and are required for seamless integration between OVOS and Mycroft componentsThis change will provide more context about the purpose of these dependencies in the deprecated requirements file.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check the latest versions of the added OVOS packages # Expected result: The versions in the requirements file should match or be close to the latest versions echo "Checking latest versions of OVOS packages:" for package in ovos-listener ovos-tts-plugin-mimic ovos-ww-plugin-precise ovos-ww-plugin-pocketsphinx do latest_version=$(pip index versions $package | head -n 1 | awk '{print $2}' | tr -d '()') echo "$package: $latest_version" done echo -e "\nVersions in requirements file:" grep -E "ovos-(listener|tts-plugin-mimic|ww-plugin-precise|ww-plugin-pocketsphinx)" requirements/extra-deprecated.txtLength of output: 1794
Script:
#!/bin/bash # Description: Fetch the latest versions of OVOS packages using PyPI's JSON API # Expected result: List of packages with their latest versions and the versions specified in the requirements file echo "Fetching latest versions of OVOS packages from PyPI:" packages=("ovos-listener" "ovos-tts-plugin-mimic" "ovos-ww-plugin-precise" "ovos-ww-plugin-pocketsphinx") for package in "${packages[@]}" do response=$(curl -s https://pypi.org/pypi/${package}/json) if [[ $? -ne 0 || -z "$response" ]]; then echo "${package}: Failed to fetch data from PyPI." continue fi latest_version=$(echo "$response" | jq -r '.info.version' 2>/dev/null) if [[ $? -ne 0 || -z "$latest_version" ]]; then echo "${package}: Unable to parse version from PyPI response." continue fi echo "${package}: Latest version: ${latest_version}" done echo -e "\nVersions in requirements file:" grep -E "ovos-(listener|tts-plugin-mimic|ww-plugin-precise|ww-plugin-pocketsphinx)" requirements/extra-deprecated.txt || echo "No OVOS packages found in requirements/extra-deprecated.txt."Length of output: 151723
requirements/requirements.txt (4)
7-7: LGTM: Minor version bump for ovos-adapt-parserThe version constraint update for
ovos-adapt-parserfrom>=0.1.1to>=0.1.2is appropriate. This minor version bump likely includes new features or non-breaking changes, adhering to semantic versioning principles.
17-17: Verify intention: Major version bump for ovos-workshopThe version constraint update for
ovos-workshopfrom>=0.0.16,<1.0.0to>=1.0.0,<2.0.0represents a significant change. This major version bump likely includes breaking changes or substantial new features, and indicates that the package has reached a stable, production-ready state.However, there's a past review comment mentioning a TODO about reverting the minimum workshop version to 0.0.16. Please confirm if this major version bump is intentional and aligns with the project's current goals.
To help verify the changes between versions, you can run the following script:
#!/bin/bash # Description: Check for changelog entries for ovos-workshop version 1.0.0 # Test: Search for changelog entries rg --type md -i "changelog|release notes" | rg -i "ovos.?workshop.*1\.0\.0"Additionally, you may want to search for any usage of
ovos-workshopin the codebase to ensure compatibility with version 1.0.0:#!/bin/bash # Description: Search for usage of ovos-workshop in the codebase # Test: Search for import statements or other usage rg --type python "from ovos.?workshop import|import ovos.?workshop"
8-8: LGTM: Version bump for ovos_ocp_pipeline_pluginThe version constraint update for
ovos_ocp_pipeline_pluginfrom>=0.1.0to>=0.1.2is appropriate. This minor version bump likely includes new features or non-breaking changes.As the update skips version 0.1.1, it might be worth checking the changelog for any significant updates or features introduced in both 0.1.1 and 0.1.2. Here's a script to help verify:
9-9: LGTM: Version bump for ovos-common-query-pipeline-pluginThe version constraint update for
ovos-common-query-pipeline-pluginfrom>=0.1.0to>=0.1.2is appropriate. This minor version bump likely includes new features or non-breaking changes.As with the previous package, this update skips version 0.1.1. It would be beneficial to check the changelog for any significant updates or features introduced in both 0.1.1 and 0.1.2. Here's a script to help verify:
mycroft/skills/core.py (1)
23-23: LGTM! Import change maintains backward compatibility.The change from
from ovos_workshop.skills.mycroft_skill import MycroftSkilltofrom ovos_workshop.skills.ovos import OVOSSkill as MycroftSkillis a good approach. It updates the underlying implementation while maintaining backward compatibility for existing skills. This allows for a smoother transition to the newOVOSSkillclass.🧰 Tools
🪛 Ruff
23-23:
ovos_workshop.skills.ovos.OVOSSkillimported but unusedRemove unused import:
ovos_workshop.skills.ovos.OVOSSkill(F401)
mycroft/skills/mycroft_skill/mycroft_skill.py (1)
32-32: Approve change with suggestions for improvementThe change to import
OVOSSkillasMycroftSkillis a good approach for maintaining backward compatibility while transitioning to a new base class. However, I have a few suggestions to improve this change:
Consider adding a deprecation warning to inform users about the future removal of the
MycroftSkillalias. This will help developers prepare for future updates.The static analysis tool suggests that this import is unused. Let's verify if it's necessary.
Update any relevant documentation to reflect this change in the base class for Mycroft skills.
Here's a suggested implementation with a deprecation warning:
import warnings from ovos_workshop.skills.ovos import OVOSSkill warnings.warn("MycroftSkill is deprecated and will be removed in a future version. Use OVOSSkill instead.", DeprecationWarning, stacklevel=2) MycroftSkill = OVOSSkillLet's verify the usage of
MycroftSkillin the codebase:This script will help us determine if the import is necessary and how widely
MycroftSkillis used in the codebase.🧰 Tools
🪛 Ruff
32-32:
ovos_workshop.skills.ovos.OVOSSkillimported but unusedRemove unused import:
ovos_workshop.skills.ovos.OVOSSkill(F401)
mycroft/__init__.py (1)
Line range hint
33-34: Approve deprecation warning.The added deprecation warning is clear, informative, and provides users with the necessary guidance for future changes. It effectively communicates:
- The deprecation of the mycroft module.
- The recommendation to start importing from ovos_core and companion packages.
- The specific version (0.2.0) when the mycroft module will be removed.
This information is crucial for users to plan their transition to the new framework.
🧰 Tools
🪛 Ruff
19-19:
ovos_workshop.intents.IntentBuilderimported but unused(F401)
19-19:
ovos_workshop.intents.Intentimported but unused(F401)
20-20:
ovos_workshop.decorators.intent_handlerimported but unused(F401)
20-20:
ovos_workshop.decorators.intent_file_handlerimported but unused(F401)
20-20:
ovos_workshop.decorators.adds_contextimported but unused(F401)
20-20:
ovos_workshop.decorators.removes_contextimported but unused(F401)
21-21:
ovos_workshop.skills.ovos.OVOSSkillimported but unused(F401)
22-22:
ovos_workshop.skills.fallback.FallbackSkillimported but unused(F401)
mycroft/skills/__init__.py (1)
25-25: Verify compatibility and consider adding a deprecation warningThe change from
MycroftSkilltoOVOSSkill(aliased asMycroftSkill) maintains backward compatibility at the API level. However, there are a few points to consider:
- Ensure that
OVOSSkillis a perfect drop-in replacement forMycroftSkillto avoid introducing subtle behavioral changes.- Consider adding a deprecation warning to inform users about this change and potential future removal of the
MycroftSkillalias. This will help with a smoother transition in the future.Consider adding a deprecation warning like this:
import warnings warnings.warn( "MycroftSkill is deprecated and will be removed in a future version. " "Use OVOSSkill from ovos_workshop.skills.ovos instead.", DeprecationWarning, stacklevel=2 )To ensure this change doesn't introduce unexpected issues, let's verify the usage and compatibility:
mycroft/skills/common_iot_skill.py (1)
27-27: LGTM! Consider updating documentation.The change from
MycroftSkilltoOVOSSkilllooks good and maintains backward compatibility through aliasing. This shift aligns with the transition to more generalized OVOS implementations.To ensure full compatibility, please verify that
OVOSSkillprovides all the necessary methods and attributes thatCommonIoTSkillexpects fromMycroftSkill. You can run the following script to compare the two classes:Consider updating the class docstring for
CommonIoTSkillto reflect that it now inherits fromOVOSSkillinstead ofMycroftSkill. This will help maintain accurate documentation for developers working with this class in the future.
some unittests moved to OpenVoiceOS/OVOS-workshop#235
brings support for ovos-workshop 1.0.0 , it removed support for running UNDER mycroft-core, this was a breaking change in some imports under the mycroft namespace
Summary by CodeRabbit
New Features
mycroftmodule, encouraging transition toovos_core.Bug Fixes
FallbackModeto ensure proper functionality within the fallback service.Chores