Standardization

[Eeems]

Update dependencies, standardize command line arguments, force format of data/version-ids.json

Summary by CodeRabbit

• Documentation
  • Improved installation instructions and command usage examples for clearer guidance.
• New Features
  • Added a reboot functionality for device management.
• Refactor
  • Updated command-line options for a more user-friendly and consistent interface.
• Style
  • Enhanced formatting for improved readability in output and configuration.
• Chores
  • Bumped the project version to 1.2.0 and updated dependency versions for enhanced stability.

[coderabbitai[bot]]

Walkthrough

This pull request updates the project’s documentation, source code formatting, and configuration files. The README now uses revised terminology and example commands for the codexctl utility. In the source code, formatting improvements and minor adjustments to CLI argument names and flags have been applied. Additionally, the JSON indentation in updates.py has been simplified, and the XML string formatting has been refined. The version-ids.json file has been completely replaced with updated content, while the project configuration file (pyproject.toml) now reflects a version bump and updated dependency versions. Furthermore, a new method for rebooting devices has been added to the DeviceManager class.

Changes

File(s)	Change Summary
README.md	Revised installation instructions and command usage. Updated the cat description to use “firmwareimage” and the extract description to use “update file”, with the download example now using --hardware instead of -hd.
codexctl/init.py	Improved code formatting for increased readability. Updated the argument parser by renaming --hardware to --device (and changing short options from -hd to -d, -nr to -R, and -no-ow to -O).
codexctl/updates.py	Changed JSON dump indentation from multi-line to single line for simplified formatting of XML string output.
data/version-ids.json	Replaced file content with updated version identifiers while keeping the existing schema and structure unchanged.
pyproject.toml	Incremented the project version from 1.1.0 to 1.2.0 and updated dependency versions for remarkable-update-image (1.1.3 → 1.1.5) and remarkable-update-fuse (1.1.2 → 1.2.3).
codexctl/device.py	Added a new method reboot_device to the DeviceManager class for handling device reboots. Updated the script path in restore_previous_version method from /usr/bin/restore.sh to /tmp/restore.sh.

Possibly related PRs

• Jayy001/codexctl#112: The changes in the main PR are related to the call_func method in the Manager class, which is also modified in the retrieved PR, specifically regarding the handling of the version argument.

✨ 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.

[Jayy001]

Thank you for all your work to this project