introducing uv in core (#4451)

* introduce uv

Signed-off-by: emdneto <[email protected]>

* remove ruff workflow

Signed-off-by: emdneto <[email protected]>

* move to workspaces

Signed-off-by: emdneto <[email protected]>

* make contributing commands copyable

Signed-off-by: emdneto <[email protected]>

* add opencensus e zipkin-proto-http to exclude list

Signed-off-by: emdneto <[email protected]>

---------

Signed-off-by: emdneto <[email protected]>
Co-authored-by: Riccardo Magliocchetti <[email protected]>

Author: emdneto

.github/workflows/misc_0.yml

@@ -236,8 +236,8 @@ jobs:
       - name: Check github workflows are up to date
         run: git diff --exit-code || (echo 'Generated workflows are out of date, run "tox -e generate-workflows" and commit the changes in this PR.' && exit 1)
 
-  ruff:
-    name: ruff
+  precommit:
+    name: precommit
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo @ SHA - ${{ github.sha }}
@@ -252,4 +252,4 @@ jobs:
         run: pip install tox
 
       - name: Run tests
-        run: tox -e ruff
+        run: tox -e precommit

.pre-commit-config.yaml

@@ -1,10 +1,15 @@
 repos:
-- repo: https://github.com/astral-sh/ruff-pre-commit
-  # Ruff version.
-  rev: v0.6.9
-  hooks:
-    # Run the linter.
-    - id: ruff
-      args: ["--fix", "--show-fixes"]
-    # Run the formatter.
-    - id: ruff-format
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.6.9
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+      # Run the formatter.
+      - id: ruff-format
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.6.0
+    hooks:
+      - id: uv-lock

CONTRIBUTING.md

@@ -45,7 +45,7 @@ some aspects of development, including testing against multiple Python versions.
 To install `tox`, run:
 
 ```console
-$ pip install tox
+pip install tox
 ```
 
 You can run `tox` with the following arguments:
@@ -60,19 +60,36 @@ You can run `tox` with the following arguments:
 - `tox -e lint-some-package` to run lint checks on `some-package`
 - `tox -e generate-workflows` to run creation of new CI workflows if tox environments have been updated
 - `tox -e ruff` to run ruff linter and formatter checks against the entire codebase
+- `tox -e precommit` to run all `pre-commit` actions
 
 `ruff check` and `ruff format` are executed when `tox -e ruff` is run. We strongly recommend you to configure [pre-commit](https://pre-commit.com/) locally to run `ruff` automatically before each commit by installing it as git hooks. You just need to [install pre-commit](https://pre-commit.com/#install) in your environment:
 
 ```console
-$ pip install pre-commit -c dev-requirements.txt
+pip install pre-commit -c dev-requirements.txt
 ```
 
 and run this command inside the git repository:
 
 ```console
-$ pre-commit install
+pre-commit install
 ```
 
+### Virtual Environment
+
+You can also create a single virtual environment to make it easier to run local tests.
+
+For that, you'll need to install [`uv`](https://docs.astral.sh/uv/getting-started/installation/).
+
+After installing `uv`, you can run the following command:
+
+```sh
+uv sync
+```
+
+This will create a virtual environment in the `.venv` directory and install all the necessary dependencies.
+
+### Public Symbols
+
 We try to keep the amount of _public symbols_ in our code minimal. A public symbol is any Python identifier that does not start with an underscore.
 Every public symbol is something that has to be kept in order to maintain backwards compatibility, so we try to have as few as possible.
 
@@ -107,7 +124,7 @@ See
 [`tox.ini`](https://github.com/open-telemetry/opentelemetry-python/blob/main/tox.ini)
 for more detail on available tox commands.
 
-#### Contrib repo
+### Contrib repo
 
 Some of the `tox` targets install packages from the [OpenTelemetry Python Contrib Repository](https://github.com/open-telemetry/opentelemetry-python.git) via
 pip. The version of the packages installed defaults to the `main` branch in that repository when `tox` is run locally. It is possible to install packages tagged
@@ -153,31 +170,45 @@ pull requests (PRs).
 To create a new PR, fork the project in GitHub and clone the upstream repo:
 
 ```console
-$ git clone https://github.com/open-telemetry/opentelemetry-python.git
-$ cd opentelemetry-python
+git clone https://github.com/open-telemetry/opentelemetry-python.git
+cd opentelemetry-python
 ```
 
 Add your fork as an origin:
 
 ```console
-$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python.git
+git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python.git
 ```
 
-Run tests:
+Make sure you have all supported versions of Python installed, install tox only for the first time:
 
 ```sh
-# make sure you have all supported versions of Python installed
-$ pip install tox  # only first time.
-$ tox  # execute in the root of the repository
+pip install tox
+```
+
+Run tests in the root of the repository (this will run all tox environments and may take some time):
+
+```sh
+tox
 ```
 
 Check out a new branch, make modifications and push the branch to your fork:
 
 ```sh
-$ git checkout -b feature
-# edit files
-$ git commit
-$ git push fork feature
+git checkout -b feature
+```
+
+After you edit the files, stage changes in the current directory:
+
+```sh
+git add .
+```
+
+Then run the following to commit the changes:
+
+```sh
+git commit
+git push fork feature
 ```
 
 Open a pull request against the main `opentelemetry-python` repo.

pyproject.toml

@@ -1,3 +1,58 @@
+[project]
+name = "opentelemetry-python"
+version = "0.0.0" # This is not used.
+requires-python = ">=3.8"
+dependencies = [
+  "opentelemetry-api",
+  "opentelemetry-sdk",
+  "opentelemetry-semantic-conventions",
+  "opentelemetry-proto",
+  "opentelemetry-test-utils",
+  "opentelemetry-exporter-otlp-proto-grpc",
+  "opentelemetry-exporter-otlp-proto-http",
+  "opentelemetry-exporter-otlp-proto-common",
+  "opentelemetry-exporter-zipkin-json",
+  "opentelemetry-exporter-prometheus",
+  "opentelemetry-propagator-jaeger",
+  "opentelemetry-propagator-b3",
+]
+
+# https://docs.astral.sh/uv/reference/settings/
+[tool.uv]
+package = false # https://docs.astral.sh/uv/reference/settings/#package
+required-version = ">=0.6.0"
+
+[tool.uv.sources]
+opentelemetry-api = { workspace = true}
+opentelemetry-sdk = { workspace = true }
+opentelemetry-proto = { workspace = true }
+opentelemetry-semantic-conventions = { workspace = true }
+opentelemetry-test-utils = { workspace = true }
+opentelemetry-exporter-otlp-proto-grpc = { workspace = true }
+opentelemetry-exporter-otlp-proto-http = { workspace = true }
+opentelemetry-exporter-otlp-proto-common = { workspace = true }
+opentelemetry-exporter-zipkin-json = { workspace = true }
+opentelemetry-exporter-prometheus = {workspace = true }
+opentelemetry-propagator-jaeger = { workspace = true }
+opentelemetry-propagator-b3 = { workspace = true }
+
+[tool.uv.workspace]
+members = [
+  "opentelemetry-api",
+  "opentelemetry-sdk",
+  "opentelemetry-semantic-conventions",
+  "opentelemetry-proto",
+  "exporter/*",
+  "propagator/*",
+  "tests/opentelemetry-test-utils",
+]
+
+exclude = [
+  "exporter/opentelemetry-exporter-opencensus",
+  "exporter/opentelemetry-exporter-zipkin",
+  "exporter/opentelemetry-exporter-zipkin-proto-http",
+]
+
 [tool.pytest.ini_options]
 addopts = "-rs -v"
 log_cli = true

tox.ini

@@ -95,7 +95,7 @@ envlist =
     public-symbols-check
     shellcheck
     generate-workflows
-    ruff
+    precommit
 
 [testenv]
 deps =
@@ -358,7 +358,7 @@ commands =
   pyright --version
   pyright
 
-[testenv:ruff]
+[testenv:{precommit,ruff}]
 basepython: python3
 deps =
   -c {toxinidir}/dev-requirements.txt