introduce uv

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

Author: emdneto

.github/workflows/misc_0.yml

@@ -253,3 +253,21 @@ jobs:
 
       - name: Run tests
         run: tox -e ruff
+
+  pre-commit:
+    name: pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Run tests
+        run: tox -e pre-commit

.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 pre-commit` 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

pyproject.toml

@@ -1,3 +1,49 @@
+[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-otlp",
+  "opentelemetry-propagator-jaeger",
+  "opentelemetry-propagator-b3",
+  "opentelemetry-exporter-zipkin-json",
+  "opentelemetry-exporter-prometheus",
+]
+
+# 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 = { path = "opentelemetry-api", editable = true}
+opentelemetry-sdk = { path = "opentelemetry-sdk", editable = true }
+opentelemetry-proto = { path = "opentelemetry-proto", editable = true }
+opentelemetry-semantic-conventions = { path = "opentelemetry-semantic-conventions", editable = true }
+opentelemetry-test-utils = { path = "tests/opentelemetry-test-utils", editable = true }
+opentelemetry-exporter-otlp-proto-grpc = { path = "exporter/opentelemetry-exporter-otlp-proto-grpc", editable = true }
+opentelemetry-exporter-otlp-proto-http = { path = "exporter/opentelemetry-exporter-otlp-proto-http", editable = true }
+opentelemetry-exporter-otlp-proto-common = { path = "exporter/opentelemetry-exporter-otlp-proto-common", editable = true }
+# zipkin
+# opentelemetry-exporter-zipkin-proto-http = { path = "exporter/opentelemetry-exporter-zipkin-proto-http", editable = true }
+opentelemetry-exporter-zipkin-json = { path = "exporter/opentelemetry-exporter-zipkin-json", editable = true }
+# opencensus
+# opentelemetry-exporter-opencensus = { path = "exporter/opentelemetry-exporter-opencensus", editable = true }
+# prometheus
+opentelemetry-exporter-prometheus = { path = "exporter/opentelemetry-exporter-prometheus", editable = true }
+opentelemetry-exporter-otlp = { path = "exporter/opentelemetry-exporter-otlp", editable = true }
+# propagators
+opentelemetry-propagator-jaeger = { path = "propagator/opentelemetry-propagator-jaeger", editable = true }
+opentelemetry-propagator-b3 = { path = "propagator/opentelemetry-propagator-b3", editable = true }
+
 [tool.pytest.ini_options]
 addopts = "-rs -v"
 log_cli = true

tox.ini

@@ -96,6 +96,7 @@ envlist =
     shellcheck
     generate-workflows
     ruff
+    pre-commit
 
 [testenv]
 deps =
@@ -360,6 +361,16 @@ commands =
 
 [testenv:ruff]
 basepython: python3
+setenv=
+  SKIP=uv-lock
+deps =
+  -c {toxinidir}/dev-requirements.txt
+  pre-commit
+commands =
+  pre-commit run --color=always --all-files {posargs}
+
+[testenv:pre-commit]
+basepython: python3
 deps =
   -c {toxinidir}/dev-requirements.txt
   pre-commit