added automatic creation of a temporary swap file

[Frix-x]

Summary by Sourcery

Add functionality for automatic creation of a temporary swap file to enhance memory management during large file processing. Update installation scripts to configure necessary permissions and improve preflight checks. Enhance documentation to guide users on configuring the new swap file feature.

New Features:

• Introduce automatic creation and management of a temporary swap file to prevent memory issues during large file processing, particularly on low-end devices.

Enhancements:

• Add a setup script to configure sudo permissions for managing swap files without requiring a password.
• Improve preflight checks and package installation logic in the installation script.

Documentation:

• Update README to include documentation on the new temporary swap file feature, explaining its purpose and configuration.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds functionality for automatic creation of a temporary swap file in the Shake&Tune module for Klipper. The changes primarily focus on improving memory management, especially for low-end devices with limited RAM. The implementation includes modifications to the installation process, core Shake&Tune functionality, and the addition of a new swap file management system.

Sequence Diagram

sequenceDiagram
    participant User
    participant ShakeTune
    participant SwapManager
    participant System

    User->>ShakeTune: Run Shake&Tune command
    ShakeTune->>SwapManager: add_swap()
    SwapManager->>System: Create and activate swap file
    ShakeTune->>ShakeTune: Process command
    ShakeTune->>SwapManager: remove_swap()
    SwapManager->>System: Deactivate and remove swap file
    ShakeTune->>User: Return results

Loading

File-Level Changes

Change	Details	Files
Implementation of temporary swap file creation and management	Added SwapManager class to handle swap file operations Integrated SwapManager into Shake&Tune's main processes Added configuration option for temporary swap file size Created install_swap_access.sh script for setting up sudo permissions	shaketune/shaketune.py shaketune/swap_manager.py install_swap_access.sh shaketune/shaketune_config.py
Updates to installation process	Added setup for Shake&Tune sudo permissions Improved cleanup of old installation files Added user prompts for reboot and service restart options	install.sh
Configuration and documentation updates	Added new configuration option 'temporary_swap_size' in README.md Updated ShakeTuneConfig class to include temp_swap_size_mb parameter	README.md shaketune/shaketune_config.py

---

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.

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]

Hey @Frix-x - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding more documentation or guidance on when and how to use the new temporary swap file feature, especially for users who may not be familiar with swap management.
• While the sudo permissions for swap file operations are limited in scope, it might be worth exploring alternative approaches that don't require elevated permissions for better security.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 1 issue found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion (documentation): Consider specifying the unit for temporary_swap_size

It would be helpful for users to know if the values 512 or 1024 are in MB, GB, or another unit.

Suggested change

	# temporary_swap_size: 0
	# This allows to specify the size of an additional temporary swap file that will be dynamically
	# created on the system to avoid running out of memory. This should help mitigating Klipper Timer
	# Too Close errors that can occur on low end devices with little RAM like the CB1 when processing
	# large measurements. If you want to use this setting, be sure to have enough disk space available
	# in your home folder, and a value like 512 or 1024 should be enough in most cases.
	# temporary_swap_size: 0
	# Specifies the size (in MB) of an additional temporary swap file that will be dynamically
	# created on the system to avoid running out of memory. This helps mitigate Klipper Timer
	# Too Close errors that can occur on low-end devices with little RAM (like the CB1) when
	# processing large measurements. If you want to use this setting, ensure you have enough
	# disk space available in your home folder. A value of 512 or 1024 (MB) should be sufficient
	# in most cases.

[sourcery-ai]

issue (code-quality): We've found these issues:

• Extract code out into method (extract-method)
• Use f-string instead of string concatenation [×2] (use-fstring-for-concatenation)