Fix/macos install packaging and docs#1832
Merged
Furtif merged 2 commits intoJul 11, 2026
Merged
Conversation
Collaborator
|
thanks |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR improves macOS installation reliability for source installs and aligns setup documentation with the current packaging behavior.
What changed
Added package data configuration so runtime files are included in built/installed distributions:
ddt4all/resources/projects.json
ddt4all/generated/locales//LC_MESSAGES/.mo
Added macOS troubleshooting notes to the main README:
Upgrade pip, setuptools, and wheel before editable installs
Recovery steps for resources/projects.json not found or invalid
Verified launch commands (ddt4all and python3 -m ddt4all)
Added matching macOS guidance in build docs (README.md) for consistency.
Why
On macOS, users with older packaging tooling can fail on pip install -e ., and some installs may miss runtime data files required at startup, causing:
resources/projects.json not found or invalid.
This PR addresses both causes:
Documentation now clearly describes the required tooling upgrade/reinstall path.
Packaging now explicitly includes required runtime resource and locale files.
Validation
Verified locally on macOS:
pip install --force-reinstall . installs package with required runtime files present.
ddt4all --help works after installation.
resources/projects.json resolves correctly from installed package.
Scope
Packaging metadata and documentation only.
No ECU logic, protocol behavior, or UI runtime logic changes.