chore: V2 migrate to uv (#239)

* Migrate project to rye and ruff for v2

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Just run ruff

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Add the core package stub

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Move cloudevents to v1

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Add extra rye configs. update locks to be OS-aware

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Migrate from rye to uv

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Use python 3.12 by default for linting

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Do not mention rye in docs

Signed-off-by: Yurii Serhiichuk <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Use stricter mypy rules. exclude v1

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Run isort, flake8

Signed-off-by: Yurii Serhiichuk <[email protected]>

* fix isort

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Run ruff with isort

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Move mypy config to pyproject

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Exclude samples as well

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Exclude samples as well

Signed-off-by: Yurii Serhiichuk <[email protected]>

* Fix mypy pre-commit setup

Signed-off-by: Yurii Serhiichuk <[email protected]>

---------

Signed-off-by: Yurii Serhiichuk <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: xSAVIKx

.github/workflows/main.yml

@@ -1,39 +1,41 @@
 name: CI
 
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 jobs:
 
   lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
         with:
-          python-version: '3.11'
-          cache: 'pip'
-          cache-dependency-path: 'requirements/*.txt'
-      - name: Install dev dependencies
-        run: python -m pip install -r requirements/dev.txt
-      - name: Run linting
-        run: python -m tox -e lint
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Set up Python
+        run: uv python install 3.12
+      - name: Install the project
+        run: uv sync --all-extras --dev
+      - name: Lint
+        run: uv run ruff check --select I
 
   test:
     strategy:
       matrix:
-        python: ['3.8', '3.9', '3.10', '3.11']
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: [ '3.9', '3.10', '3.11', '3.12' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
         with:
-          python-version: ${{ matrix.python }}
-          cache: 'pip'
-          cache-dependency-path: 'requirements/*.txt'
-      - name: Install dev dependencies
-        run: python -m pip install -r requirements/dev.txt
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install the project
+        run: uv sync --all-extras --dev
       - name: Run tests
-        run: python -m tox -e py  # Run tox using the version of Python in `PATH`
+        run: uv run pytest tests

.pre-commit-config.yaml

@@ -1,27 +1,24 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-toml
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.8
     hooks:
-      - id: isort
-        args: [ "--profile", "black", "--filter-files" ]
-  - repo: https://github.com/psf/black
-    rev: 24.4.2
-    hooks:
-      - id: black
-        language_version: python3.11
+      # Run the linter.
+      - id: ruff
+      # Run the formatter.
+      - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.0
+    rev: v1.11.2
     hooks:
       - id: mypy
-        files: ^(cloudevents/)
-        exclude: ^(cloudevents/tests/)
+        files: ^(src/cloudevents/|tests/)
+        exclude: ^(src/cloudevents/v1/)
         types: [ python ]
-        args: [ ]
-        additional_dependencies:
-          - "pydantic~=2.7"
+        args: [
+          "--config-file=pyproject.toml",
+        ]

README.md

@@ -1,4 +1,4 @@
-# Python SDK for [CloudEvents](https://github.com/cloudevents/spec)
+# Python SDK v2 for [CloudEvents](https://github.com/cloudevents/spec)
 
 [![PyPI version](https://badge.fury.io/py/cloudevents.svg)](https://badge.fury.io/py/cloudevents)
 
@@ -10,12 +10,11 @@ will) break with every update.
 This SDK current supports the following versions of CloudEvents:
 
 - v1.0
-- v0.3
 
 ## Python SDK
 
-Package **cloudevents** provides primitives to work with CloudEvents specification:
-https://github.com/cloudevents/spec.
+Package [**cloudevents**](src/cloudevents) provides primitives to work with
+[CloudEvents specification](https://github.com/cloudevents/spec).
 
 ### Installing
 
@@ -33,15 +32,15 @@ Below we will provide samples on how to send cloudevents using the popular
 ### Binary HTTP CloudEvent
 
 ```python
-from cloudevents.http import CloudEvent
-from cloudevents.conversion import to_binary
+from cloudevents_v1.http import CloudEvent
+from cloudevents_v1.conversion import to_binary
 import requests
 
 # Create a CloudEvent
 # - The CloudEvent "id" is generated if omitted. "specversion" defaults to "1.0".
 attributes = {
-    "type": "com.example.sampletype1",
-    "source": "https://example.com/event-producer",
+  "type": "com.example.sampletype1",
+  "source": "https://example.com/event-producer",
 }
 data = {"message": "Hello World!"}
 event = CloudEvent(attributes, data)
@@ -56,15 +55,15 @@ requests.post("<some-url>", data=body, headers=headers)
 ### Structured HTTP CloudEvent
 
 ```python
-from cloudevents.conversion import to_structured
-from cloudevents.http import CloudEvent
+from cloudevents_v1.conversion import to_structured
+from cloudevents_v1.http import CloudEvent
 import requests
 
 # Create a CloudEvent
 # - The CloudEvent "id" is generated if omitted. "specversion" defaults to "1.0".
 attributes = {
-    "type": "com.example.sampletype2",
-    "source": "https://example.com/event-producer",
+  "type": "com.example.sampletype2",
+  "source": "https://example.com/event-producer",
 }
 data = {"message": "Hello World!"}
 event = CloudEvent(attributes, data)
@@ -87,28 +86,28 @@ The code below shows how to consume a cloudevent using the popular python web fr
 ```python
 from flask import Flask, request
 
-from cloudevents.http import from_http
+from cloudevents_v1.http import from_http
 
 app = Flask(__name__)
 
 
 # create an endpoint at http://localhost:/3000/
 @app.route("/", methods=["POST"])
 def home():
-    # create a CloudEvent
-    event = from_http(request.headers, request.get_data())
+  # create a CloudEvent
+  event = from_http(request.headers, request.get_data())
 
-    # you can access cloudevent fields as seen below
-    print(
-        f"Found {event['id']} from {event['source']} with type "
-        f"{event['type']} and specversion {event['specversion']}"
-    )
+  # you can access cloudevent fields as seen below
+  print(
+    f"Found {event['id']} from {event['source']} with type "
+    f"{event['type']} and specversion {event['specversion']}"
+  )
 
-    return "", 204
+  return "", 204
 
 
 if __name__ == "__main__":
-    app.run(port=3000)
+  app.run(port=3000)
 ```
 
 You can find a complete example of turning a CloudEvent into a HTTP request
@@ -162,18 +161,13 @@ with one of the project's SDKs, please send an email to
 
 ## Maintenance
 
-We use [black][black] and [isort][isort] for autoformatting. We set up a [tox][tox]
-environment to reformat the codebase.
-
-e.g.
-
-```bash
-pip install tox
-tox -e reformat
-```
+We use [uv][uv] for dependency and package management, [ruff][ruff] and [isort][isort]
+for autoformatting and [pre-commit][pre-commit] to automate those with commit
+hooks.
 
 For information on releasing version bumps see [RELEASING.md](RELEASING.md)
 
-[black]: https://black.readthedocs.io/
+[uv]: https://docs.astral.sh/uv/
+[ruff]: https://docs.astral.sh/ruff
 [isort]: https://pycqa.github.io/isort/
-[tox]: https://tox.wiki/
+[pre-commit]: https://pre-commit.com

RELEASING.md

@@ -4,15 +4,15 @@ This repository is configured to automatically publish the corresponding [PyPI
 package](https://pypi.org/project/cloudevents/) and GitHub Tag via GitHub Actions.
 
 To release a new CloudEvents SDK, contributors should bump `__version__` in
-[cloudevents](cloudevents/__init__.py) to reflect the new release version. On merge, the action
+[cloudevents](cloudevents_v1/__init__.py) to reflect the new release version. On merge, the action
 will automatically build and release to PyPI using
 [this PyPI GitHub Action](https://github.com/pypa/gh-action-pypi-publish). This
 action gets called on all pushes to main (such as a version branch being merged
 into main), but only releases a new version when the version number has changed. Note,
 this action assumes pushes to main are version updates. Consequently,
 [pypi-release.yml](.github/workflows/pypi-release.yml) will fail if you attempt to
 push to main without updating `__version__` in
-[cloudevents](cloudevents/__init__.py) so don't forget to do so.
+[cloudevents](cloudevents_v1/__init__.py) so don't forget to do so.
 
 After a version update is merged, the script [pypi_packaging.py](pypi_packaging.py)
 will create a GitHub tag for the new cloudevents version using `__version__`.