Update 'poetry run' command in README #2011

geetikakay · 2024-08-08T13:28:20Z

Short description:

More details:

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewer:

Bug:

Summary by CodeRabbit

Documentation
- Added a new section to the README for the class-generator project, detailing how to execute the script using Poetry, improving user guidance.

Signed-off-by: Geetika Kapoor <gkapoor@redhat.com>

redhat-qe-bot · 2024-08-08T13:28:31Z

Report bugs in Issues

The following are automatically added:

Add reviewers from OWNER file (in the root of the repository) under reviewers section.
Set PR size label.
New issue is created for the PR. (Closed when PR is merged/closed)
Run pre-commit if .pre-commit-config.yaml exists in the repo.

Available user actions:

To mark PR as WIP comment /wip to the PR, To remove it from the PR comment /wip cancel to the PR.
To block merging of PR comment /hold, To un-block merging of PR comment /hold cancel.
To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
verified label removed on each new commit push.
To cherry pick a merged PR comment /cherry-pick <target branch to cherry-pick to> in the PR.
- Multiple target branches can be cherry-picked, separated by spaces. (/cherry-pick branch1 branch2)
- Cherry-pick will be started when PR is merged
To build and push container image command /build-and-push-container in the PR (tag will be the PR number).
- You can add extra args to the Podman build command
  - Example: /build-and-push-container --build-arg OPENSHIFT_PYTHON_WRAPPER_COMMIT=<commit_hash>
To add a label by comment use /<label name>, to remove, use /<label name> cancel
To assign reviewers based on OWNERS file use /assign-reviewers
To check if PR can be merged use /check-can-merge

Supported /retest check runs

/retest tox: Retest tox
/retest python-module-install: Retest python-module-install

Supported labels

hold
verified
wip
lgtm

myakove · 2024-08-09T22:38:46Z

class_generator/README.md

+- Calling the script with poetry
+
+```bash
+poetry run class-generator --kind <kind>


This is not needed, once running poetry install it will install it system-wide and run it inside poetry.

What is needed is to change the install command, installation should be done with pipx or pip

using pipx
pipx install openshift-python-wrapper

using pip
python 3 -m pip install openshift-python-wrapper

myakove · 2024-08-10T22:13:18Z

@coderabbitai review

coderabbitai · 2024-08-10T22:13:23Z

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2024-08-10T22:13:26Z

Walkthrough

The recent update enhances the class-generator project documentation by introducing a new section in the README file. This section provides users with clear instructions on executing the class generator script within a Poetry-managed environment, emphasizing the use of the poetry run command. This addition improves user experience by making it easier for developers to utilize the tool effectively.

Changes

Files	Change Summary
class_generator/README.md	Added instructions for running the class generator using Poetry.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3c04f85 and 02d7d29.

Files selected for processing (1)

class_generator/README.md (1 hunks)

Files skipped from review due to trivial changes (1)

class_generator/README.md

myakove · 2024-08-13T07:29:29Z

class_generator/README.md

+- Calling the script with poetry
+
+```bash
+poetry run class-generator --kind <kind>


What is needed is to change the install command, installation should be done with pipx or pip

using pipx
pipx install openshift-python-wrapper

using pip
python 3 -m pip install openshift-python-wrapper

myakove · 2024-08-15T06:48:45Z

@geetikakay already fixed as part of the refactoring of the class-generator, please close this.

Update 'poetry run' command in README

02d7d29

Signed-off-by: Geetika Kapoor <gkapoor@redhat.com>

redhat-qe-bot added the size/XS label Aug 8, 2024

redhat-qe-bot requested a review from omrirh August 8, 2024 13:28

redhat-qe-bot added the branch-main label Aug 8, 2024

redhat-qe-bot requested review from myakove and rnetser August 8, 2024 13:28

myakove requested changes Aug 9, 2024

View reviewed changes

redhat-qe-bot added the changes-requested-myakove label Aug 9, 2024

coderabbitai bot reviewed Aug 10, 2024

View reviewed changes

rh-bot-1 added the commented-coderabbitai[bot] label Aug 10, 2024

redhat-qe-bot1 added the needs-rebase label Aug 12, 2024

myakove requested changes Aug 13, 2024

View reviewed changes

redhat-qe-bot1 added the commented-geetikakay label Aug 13, 2024

geetikakay closed this Aug 15, 2024

Update 'poetry run' command in README #2011

Update 'poetry run' command in README #2011

Uh oh!

Conversation

geetikakay commented Aug 8, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Short description:

More details:

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewer:

Bug:

Summary by CodeRabbit

Uh oh!

redhat-qe-bot commented Aug 8, 2024

Uh oh!

myakove Aug 9, 2024

Choose a reason for hiding this comment

Uh oh!

myakove Aug 13, 2024

Choose a reason for hiding this comment

Uh oh!

geetikakay Aug 13, 2024

Choose a reason for hiding this comment

Uh oh!

myakove commented Aug 10, 2024

Uh oh!

coderabbitai bot commented Aug 10, 2024

Uh oh!

coderabbitai bot commented Aug 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

myakove Aug 13, 2024

Choose a reason for hiding this comment

Uh oh!

myakove commented Aug 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

geetikakay commented Aug 8, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 10, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)