Skip to content

Comments

docs: add Windows troubleshooting guide for libmagic and MySQL#1025

Open
Laks-D wants to merge 4 commits intoCCExtractor:masterfrom
Laks-D:master
Open

docs: add Windows troubleshooting guide for libmagic and MySQL#1025
Laks-D wants to merge 4 commits intoCCExtractor:masterfrom
Laks-D:master

Conversation

@Laks-D
Copy link

@Laks-D Laks-D commented Feb 19, 2026

[IMPROVEMENT]

In raising this pull request, I confirm the following (please check boxes):

  • I have read and understood the contributors guide.
  • I have checked that another pull request for this purpose does not exist.
  • I have considered, and confirmed that this submission will be valuable to others.
  • I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  • I give this submission freely, and claim no ownership to its content.

My familiarity with the project is as follows (check one):

  • I have never used the project.
  • I have used the project briefly.
  • I have used the project extensively, but have not contributed previously.
  • I am an active contributor to the project.

Description

This PR introduces a dedicated Windows Troubleshooting section to the README.md. During the local setup process on a Windows environment, I identified and resolved several recurring blockers:

  • libmagic dependency: Standard python-magic often fails to locate DLLs on Windows; added python-magic-bin workaround.
  • MySQL Driver compatibility: Documented the pymysql dialect requirement for stable SQLAlchemy connections on local Windows MySQL instances.
  • PowerShell Syntax: Provided the correct $env:FLASK_APP syntax for setting environment variables in Windows terminals.

Impact

These updates aim to streamline the onboarding process for new Windows-based contributors, reducing setup friction for the Sample Platform NG project.

Verification

  • Verified python-magic-bin resolves the ImportError on Windows 11.
  • Validated pymysql connection string in config.py.
  • Confirmed PowerShell environment variable persistence for flask db commands.

@sonarqubecloud
Copy link

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.

1 participant