Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve macOS Apple Silicon installation instructions #990

Merged

Conversation

wpoPR
Copy link

@wpoPR wpoPR commented Mar 20, 2025

Followed the README but ran into some errors running it locally. Made a few tweaks and got it working on my M3 PRO. Found this PR (Failing to run on Apple Silicon Mac M3) and thought improving the instructions might help others. Hope this helps!

great tool guys, thx a lot

Summary by Sourcery

Improve the macOS installation instructions in the README, specifically for Apple Silicon (M1/M2/M3) users. The instructions now include details about installing Python 3.10, the tkinter package, and creating a virtual environment with Python 3.10.

Followed the `README` but ran into some errors running it locally. Made a few tweaks and got it working on my M3 PRO. Found this PR (Failing to run on Apple Silicon Mac M3) and thought improving the instructions might help others. Hope this helps!

great tool guys, thx a lot
Copy link
Contributor

sourcery-ai bot commented Mar 20, 2025

Reviewer's Guide by Sourcery

This pull request improves the macOS Apple Silicon installation instructions in the README. It addresses common issues encountered during setup, such as Python version conflicts and missing tkinter package, by providing specific instructions and troubleshooting tips. The changes aim to streamline the installation process and make it more user-friendly for Apple Silicon users.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Improved the macOS Apple Silicon installation instructions to address common issues and ensure a smoother setup process.
  • Specified the use of Python 3.10 for Apple Silicon (M1/M2/M3) installations due to compatibility issues with newer versions.
  • Added instructions to install [email protected] using brew to resolve _tkinter missing errors.
  • Clarified the usage of python3.10 command instead of python to avoid confusion when multiple Python versions are installed.
  • Included a troubleshooting tip for model loading errors, advising users to check the location of their models.
  • Added instructions to create and activate a virtual environment using Python 3.10.
  • Reordered the steps for installing dependencies to ensure python-tk is installed before creating the virtual environment.
README.md
Minor grammatical improvements and clarifications.
  • Corrected "don’t" to "don't".
  • Added cd Deep-Live-Cam after cloning the repository.
README.md

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for 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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Overall Comments:

  • Thanks for improving the installation instructions for macOS, especially for Apple Silicon users.
  • Consider adding a note about uninstalling conflicting Python versions if users encounter issues.
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: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

follow sourcery-ai and add a note about uninstalling conflicting Python versions if users encounter issues.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants