Add Environment Documentation for Virtual Environment Including Local Core Repository#4669
Open
SoulofAkuma wants to merge 3 commits into
Open
Add Environment Documentation for Virtual Environment Including Local Core Repository#4669SoulofAkuma wants to merge 3 commits into
SoulofAkuma wants to merge 3 commits into
Conversation
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
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.
Description
This PR adds documentation and a script to make it easier to setup a local workspace that contains both the core python repository as well as this one. Using the documentation provided in
CONTRIBUTING.mdand having limited knowledge ofuv, I found it challenging to troubleshoot issues that may be in the core or in the contrib repository.I have now added documentation on how to manually modify the
uvconfiguration inpyproject.tomlto resolve these dependencies locally, as well as a script that scans thepyproject.tomlfiles of both the core and the contrib repository. Specifically, the helper script detects all dependencies in the contrib'spyproject.tomlwhich are not workspace dependencies, but which can be resolved via the core repository locally.Unfortunately, to my knowledge it is not a feature in uv itself to combine two workspaces like this, hence the helper script and added documentation.
Fixes #4639
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Simply clone the core repository and the contrib one locally and then run the script referencing the two pyproject.toml files.
Finally, replace the contrib's
tool.uv.sourcessection in thepyproject.tomlwith the output of the script and runuv sync.The environment that is being created should use local file references for any dependencies that are available in the core repositroy.
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.
Changelogs have been updated- documentation change and helper script onlyPlease let me know if a changelog should still be added for this due to the added helper script.