fix: setup.py to read README.md with UTF-8 encoding #59 #60
+113
−51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shivam-singhal
requested changes
Feb 4, 2025
There was a problem hiding this comment.
@aaryan182 great work here! had some changes in the project structure, can you rebase and confirm that everything works?
Also, could you include screenshots of the error + fixed run, as well as the logo rounded edges visuals?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fix addresses a UnicodeDecodeError that occurred while running pip install -e ".[dev]" --verbose. The issue was caused by Python using the default system encoding when reading README.md in setup.py which led to decoding failures on certain systems (especially Windows).
Fix Details
Explicitly specify encoding="utf-8" when reading README.md in setup.py.
This ensures the file is correctly read on all operating systems preventing installation failures.
Testing
Verified the fix by running pip install -e ".[dev]" --verbose ensuring the installation completes successfully.
Related Issue
Fixes #59