Skip to content

Add Environment Documentation for Virtual Environment Including Local Core Repository#4669

Open
SoulofAkuma wants to merge 3 commits into
open-telemetry:mainfrom
SoulofAkuma:add-devenv-documentation
Open

Add Environment Documentation for Virtual Environment Including Local Core Repository#4669
SoulofAkuma wants to merge 3 commits into
open-telemetry:mainfrom
SoulofAkuma:add-devenv-documentation

Conversation

@SoulofAkuma

Copy link
Copy Markdown

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.md and having limited knowledge of uv, 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 uv configuration in pyproject.toml to resolve these dependencies locally, as well as a script that scans the pyproject.toml files of both the core and the contrib repository. Specifically, the helper script detects all dependencies in the contrib's pyproject.toml which 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.

  • New feature/Documentation (non-breaking change which adds functionality)

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.sources section in the pyproject.toml with the output of the script and run uv 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?

  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated - documentation change and helper script only
  • Unit tests have not been added - documentation change and helper script only
  • Documentation has been updated

Please let me know if a changelog should still be added for this due to the added helper script.

@SoulofAkuma SoulofAkuma requested a review from a team as a code owner June 7, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Provide Documentation to Set Up Shared -contrib and sdk Workspace

1 participant