Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: standard naming for PyPi #14

Merged
merged 2 commits into from
Nov 4, 2024
Merged

fix: standard naming for PyPi #14

merged 2 commits into from
Nov 4, 2024

Conversation

mikejgray
Copy link
Collaborator

@mikejgray mikejgray commented Nov 4, 2024

Summary by CodeRabbit

  • New Features
    • Updated project metadata, including a new project URL and package name.
    • Revised author information to reflect new ownership and branding.
  • Tests
    • Updated test configurations to align with the new skill ID for accurate testing.

Copy link

coderabbitai bot commented Nov 4, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve modifications to the setup.py file of a Python package. Key updates include changing the project URL, package name, author name, and author email to reflect a new ownership or branding. Additionally, the test/test_skill.py file has been updated to align with the new package name and skill ID in the tests. The core functionality and structure of both files remain unchanged, ensuring that the package setup process and tests continue to operate as intended.

Changes

File Change Summary
setup.py Updated project URL, package name, author name, and author email.
test/test_skill.py Updated test_skill fixture and assertions to reflect new skill ID and package name.

Possibly related PRs

  • fix: standard naming for PyPi #14: The changes in this PR directly match the modifications made to the setup.py file in the main PR, including updates to the package URL, name, author, and author email.

Suggested reviewers

  • JarbasAl

Poem

In the garden where skills bloom bright,
A name change brings new delight.
OpenVoiceOS takes the stage,
As we turn a brand new page.
With every hop, we celebrate,
A fresh start, oh, isn't it great? 🐇✨


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the fix label Nov 4, 2024
@github-actions github-actions bot added fix and removed fix labels Nov 4, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
setup.py (1)

71-72: Consider using an organization email address.

While the author name has been updated to "OpenVoiceOS", the contact email remains a personal email address. This might cause confusion about package ownership and support channels.

Consider using an organizational email address (e.g., contact@openvoiceos.org or similar) to maintain consistency with the package ownership.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 96503ea and 9324286.

📒 Files selected for processing (1)
  • setup.py (2 hunks)
🔇 Additional comments (1)
setup.py (1)

Line range hint 11-14: LGTM! Automated derivation maintains consistency.

The skill author and name are correctly derived from the URL, ensuring consistency across the package metadata and entry points.

@@ -3,9 +3,9 @@
from os import walk, path

BASEDIR = path.abspath(path.dirname(__file__))
URL = "https://github.com/mikejgray/skill-randomness"
URL = "https://github.com/openvoiceos/skill-ovos-randomness"
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Breaking changes detected in package references

The verification revealed several instances where the old package name needs to be updated:

  • Test files still reference the old skill ID skill-randomness.mikejgray:
    • test/test_skill.py: Contains hardcoded references in test cases
    • Directory structure still uses skill_randomness instead of ovos_skill_randomness

The package renaming requires additional changes beyond setup.py to maintain consistency and prevent test failures.

🔗 Analysis chain

LGTM! Note: Breaking change in package name.

The package renaming from skill-randomness to ovos-skill-randomness follows the standard OpenVoiceOS naming convention, improving discoverability. However, this is a breaking change that will affect existing installations.

Let's verify if there are any existing installations or references to the old package name:

Also applies to: 8-8

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any references to the old package name in the codebase
rg "skill-randomness" --type-add 'requirements:*.txt' --type requirements

Length of output: 73


Script:

#!/bin/bash
# Let's try a broader search for any requirements files
fd "requirements.txt|setup.py" --type f --exec cat {}

# Also search for any potential references to the package name in other files
rg -i "skill.?randomness" --type py

Length of output: 4289

@mikejgray mikejgray merged commit 6848e65 into dev Nov 4, 2024
4 checks passed
@mikejgray mikejgray deleted the FIX_Pypi branch November 4, 2024 01:48
@github-actions github-actions bot added fix and removed fix labels Nov 4, 2024
mikejgray added a commit that referenced this pull request Nov 5, 2024
* feat: first PyPi release (#6)

* feat: first PyPi release

* fix enclosure blink (#7)

* automations/translations

* translations/allow_UNUSED_keywords

* fix:long description (#11)

semver automations fail if dont use full path for README

* chore: new automations (#10)

* bump minimum version - icepool is only supported in Python 3.10+

* chore(automations): tidy up and get a release out (#13)

* Increment Version to 0.0.2a1

* Update Changelog

* fix: standard naming for PyPi (#14)

* Increment Version to 0.0.3a1

* Update Changelog

* feat: support more Python versions, fix workflows (#15)

* feat: support more Python versions (3.9+), fix workflows

* Increment Version to 0.1.0a1

* Update Changelog

* fix: enable language support in LF

* address odd verison.py

* chore: remove old translation test file

---------

Co-authored-by: JarbasAI <33701864+JarbasAl@users.noreply.github.com>
Co-authored-by: miro <jarbasai@mailfence.com>
Co-authored-by: mikejgray <mikejgray@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant