ramalama icon indicating copy to clipboard operation
ramalama copied to clipboard

Switch python3-ramalama to ramalama

Open ericcurtin opened this issue 7 months ago • 7 comments

Because we are a python application rather than a python library, we have this option, it's more intuitive in general and puts us in line with brew install ramalama. We want to alias python3-ramalama.

Summary by Sourcery

Alias python3-ramalama to ramalama across installation instructions and scripts

Enhancements:

  • Modify install script to install the ramalama package name with dnf

Documentation:

  • Update README install commands to use ramalama instead of python3-ramalama

ericcurtin avatar May 21 '25 18:05 ericcurtin

Reviewer's Guide

This PR replaces all references to the Fedora package “python3-ramalama” with the new alias “ramalama” in documentation, the install script, and provisioning plans to make the installation command more intuitive and consistent.

File-Level Changes

Change Details Files
Replace python3-ramalama with ramalama as the default Fedora package
  • Updated the install command in the README
  • Modified the dnf_install call in install.sh
  • Aligned the package name in plans/main.fmf
README.md
install.sh
plans/main.fmf

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. You can also reply to a review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you want it. You can also comment @sourcery-ai summary on the pull request to (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard 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 for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar May 21 '25 18:05 sourcery-ai[bot]

Was chatting to @carlwgeorge and we think it makes sense to change the primary name of the package to be the application/executable name and make python3-ramalama be an alias. Looping @smooge in.

Opening this draft PR so I don't forget about it.

ericcurtin avatar May 21 '25 18:05 ericcurtin

While I was discussing this with @ericcurtin I think I mistakenly said that renaming the package didn't require a re-review, but it actually does.

https://docs.fedoraproject.org/en-US/package-maintainers/Package_Renaming_Process/

I'm happy to perform that official review in bugzilla once someone submits it.

Should this PR include renaming rpm/python-ramalama.spec to rpm/ramalama.spec, along with the necessary changes to the spec file?

carlwgeorge avatar May 25 '25 04:05 carlwgeorge

I was wondering if it would be ok to do

Provides: ramalama

which should(?) allow for dnf install ramalama to work.

Changing the package in Fedora from python-ramalama to ramalama would require changes in the spec file, the Fedora package system, and packit to make it work. I would actually put this Patch Set as the last one to be done in that series. I can start working on this but want to make sure it is what is wanted

smooge avatar May 26 '25 15:05 smooge

ramalama would be a better primary name @smooge but I trust your judgement

ericcurtin avatar May 26 '25 17:05 ericcurtin

@smooge we heard a few comments from people in the Fedora world who felt that libraries should be python-FOOBAR, while tools should just be FOOBAR. Since ramalama is not really used as a library, then renaming everything to ramalama makes sense.

rhatdan avatar May 27 '25 12:05 rhatdan

Indeed, the package guidelines state that Python libraries MUST be named with the python3- prefix (python- for the source package), but applications SHOULD be named according to the general naming guidelines.

carlwgeorge avatar May 27 '25 14:05 carlwgeorge

Either this can be merged now or this has been supplanted by a different PR?

rhatdan avatar Jun 11 '25 03:06 rhatdan

This needs to wait until I get the other one done in Fedora. Currently these changes would break someone in Fedora or EPEL. So first #1498 , then I get it reviewed and do the releng doe-see-do dance and then #1433

smooge avatar Jun 11 '25 14:06 smooge

@ericcurtin can this move forward now?

rhatdan avatar Jun 30 '25 14:06 rhatdan

This has been done in the main branch.

rhatdan avatar Jul 21 '25 23:07 rhatdan