Avoid importing jmp cli when running j command

[NickCao]

Summary by CodeRabbit

• New Features
  • Introduced a revamped command-line interface with a structured command group for executing tasks.
• Bug Fixes
  • Adjusted import statements for improved module access and functionality.
• Refactor
  • Consolidated and reorganized CLI commands for improved consistency and maintainability.
  • Updated script entry references to reflect the new module structure.

[coderabbitai]

Walkthrough

The changes remove the CLI entry point originally defined in the __init__.py file and shift the command definitions to a new file (jmp.py). The import in the __main__.py file is updated to reflect the new module structure. Additionally, a new entry point (j) with a dedicated function is introduced in j.py. The project script entries in pyproject.toml are altered to use dot notation for module paths. Overall, the modifications reassign the CLI functionalities, moving core implementations to jmp.py and introducing an alternative entry point.

Changes

File(s)	Change Summary
packages/jumpstarter-cli/jumpstarter_cli/__init__.py	Removed CLI Entry Point: Entirely removed file, eliminating imports, command group jmp, and associated CLI commands (create, delete, update, get, shell, run, login, config, driver, admin, and version).
packages/jumpstarter-cli/jumpstarter_cli/__main__.py	Updated Import Statement: Changed import from from . import jmp to from .jmp import jmp; functionality remains the same.
packages/jumpstarter-cli/jumpstarter_cli/j.py	New Entry Point: Added function j() with a conditional check to run if the module is executed as the main program.
packages/jumpstarter-cli/jumpstarter_cli/jmp.py	New CLI Implementation: Introduced a new file that implements the CLI using asyncclick. Registers the command group jmp with subcommands (create, delete, update, get, shell, run, login, config, driver, admin, and version) and configures logging.
packages/jumpstarter-cli/pyproject.toml	Script Entry Updates: Changed script entries to use dot notation (jmp = "jumpstarter_cli.jmp:jmp" and j = "jumpstarter_cli.j:j") to reflect the updated module structure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Main as __main__.py
    participant CLI as jmp.py
    participant Subcommand as CLI Subcommands

    User->>Main: Execute "jmp" command
    Main->>CLI: Import and call jmp(prog_name="jmp")
    CLI->>CLI: Configure logging & initialize command group
    CLI->>Subcommand: Route command execution (e.g., create, delete, etc.)
    Subcommand-->>CLI: Return command result
    CLI-->>User: Output results

Loading

sequenceDiagram
    participant User
    participant JScript as j.py

    User->>JScript: Execute "j" command
    JScript->>JScript: Check if __name__ == "__main__"
    JScript->>JScript: Call function j()
    JScript-->>User: Execute associated functionality

Loading

Suggested reviewers

• mangelajo

Poem

I’m a rabbit on the run,
Hopping through the code with fun.
New CLI paths light the way,
Commands now dance in bright array.
With every jump, a bug undone—
Celebrate these changes, one by one!
🐰🌟 Happy hops in every run!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8fca367 and 625b406.

📒 Files selected for processing (6)

• packages/jumpstarter-cli/jumpstarter_cli/__init__.py (0 hunks)
• packages/jumpstarter-cli/jumpstarter_cli/__main__.py (1 hunks)
• packages/jumpstarter-cli/jumpstarter_cli/cli_test.py (1 hunks)
• packages/jumpstarter-cli/jumpstarter_cli/j.py (1 hunks)
• packages/jumpstarter-cli/jumpstarter_cli/jmp.py (1 hunks)
• packages/jumpstarter-cli/pyproject.toml (1 hunks)

💤 Files with no reviewable changes (1)

• packages/jumpstarter-cli/jumpstarter_cli/init.py

🚧 Files skipped from review as they are similar to previous changes (3)

• packages/jumpstarter-cli/jumpstarter_cli/j.py
• packages/jumpstarter-cli/pyproject.toml
• packages/jumpstarter-cli/jumpstarter_cli/main.py

🧰 Additional context used

🧬 Code Definitions (1)

packages/jumpstarter-cli/jumpstarter_cli/cli_test.py (1)

packages/jumpstarter-cli/jumpstarter_cli/jmp.py (1)

• jmp (20-26)

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: e2e
• GitHub Check: pytest-matrix (3.12)
• GitHub Check: pytest-matrix (3.13)
• GitHub Check: pytest-matrix (3.11)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-utils Dockerfile.utils)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-devspace .devfile/Containerfile.client)
• GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)

🔇 Additional comments (6)

packages/jumpstarter-cli/jumpstarter_cli/cli_test.py (1)

4-4: Import statement correctly updated to reflect new module structure.

The import has been properly updated to import the jmp function directly from the new jmp.py module, maintaining the test's functionality while aligning with the project's restructured architecture.

packages/jumpstarter-cli/jumpstarter_cli/jmp.py (5)

1-16: Well-organized import structure.

The imports are properly organized with standard library imports first, followed by third-party packages, and then local modules. This follows Python best practices and improves readability.

---

18-26: CLI command group properly implemented.

The jmp function is correctly decorated as a command group with appropriate logging configuration. The default logging level (INFO) provides a good balance between verbosity and important information.

---

29-40: Command registration is comprehensive and well-organized.

All the necessary subcommands are properly added to the main command group, matching the commands verified in the test file. The organization groups related commands together logically.

---

42-43: Standard entry point implementation.

The module uses the conventional Python pattern for making it executable, allowing direct invocation of the CLI.

---

1-44: Implementation aligns with PR objectives.

Moving the CLI implementation from __init__.py to a dedicated jmp.py file successfully separates the entry points, which should prevent unnecessary imports when running the j command as intended by the PR.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[netlify]

✅ Deploy Preview for jumpstarter-docs ready!

Name	Link
🔨 Latest commit	625b406
🔍 Latest deploy log	https://app.netlify.com/sites/jumpstarter-docs/deploys/67eac85c895a950008dea132
😎 Deploy Preview	https://deploy-preview-385--jumpstarter-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.