uv project

Author: kellerza

.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions-deps:
+        patterns:
+          - "*"
+
+  # - package-ecosystem: "uv"
+  #   directory: "/"
+  #   schedule:
+  #     interval: "daily"
+  #   groups:
+  #     dev-deps:
+  #       dependency-type: "development"

.github/workflows/python-app.yml

@@ -8,6 +8,8 @@ on:
 
 env:
   DEFAULT_PYTHON: "3.10"
+  RUFF_VERSION: 0.14.10
+  UV_VERSION: 0.9.18
 
 permissions:
   contents: read
@@ -16,8 +18,14 @@ jobs:
   ruff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
       - uses: chartboost/ruff-action@v1
+        with:
+          version: ${{ env.RUFF_VERSION }}
+      # - uses: chartboost/ruff-action@v1
+      #   with:
+      #     args: "format --check"
+      #     version: ${{ env.RUFF_VERSION }}
 
   black:
     runs-on: ubuntu-latest
@@ -35,14 +43,15 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r requirements-dev.txt
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: ${{ env.UV_VERSION }}
+      - name: Install Requirements
+        run: uv sync --frozen --all-extras
       - name: Run Pylint
         run: |
-          pylint --disable=too-many-positional-arguments office365
+          uv run pylint --disable=too-many-positional-arguments office365
 
   pytest:
     runs-on: ubuntu-latest
@@ -51,16 +60,13 @@ jobs:
       - black
       - pylint
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r requirements-dev.txt
+      - name: Install Requirements
+        run: uv sync --frozen --all-extras
       - name: Test with pytest (skip entirely if secrets missing)
         env:
           office365_python_sdk_securevars: ${{ secrets.OFFICE365_PYTHON_SDK_SECUREVARS }}
@@ -69,5 +75,5 @@ jobs:
             echo "No secrets available; skipping pytest"; \
             exit 0; \
           else \
-            pytest; \
+            uv run pytest; \
           fi

.gitignore

@@ -16,6 +16,10 @@ venv.bak/
 # C extensions
 *.so
 
+# Caches
+.mypy_cache
+.ruff_cache
+
 # Distribution / packaging
 .Python
 build/

.pre-commit-config.yaml

@@ -1,12 +1,41 @@
 repos:
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.292
+
+  - repo: local
     hooks:
-      - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
+      - id: pyproject-fmt
+        name: pyproject-fmt
+        entry: uv run pyproject-fmt pyproject.toml
+        language: system
+        pass_filenames: false
+
+      - id: uv-lock
+        name: uv lock
+        entry: uv lock
+        language: system
+        pass_filenames: false
+
+      - id: ruff-check
+        name: ruff-check
+        entry: uv run ruff check --fix --exit-non-zero-on-fix
+        language: system
+        pass_filenames: false
+
+      # A proposal to replace black & pylint
+      # - id: ruff-format
+      #   name: ruff-format
+      #   entry: uv run ruff format --exit-non-zero-on-fix
+      #   language: system
+      #   pass_filenames: false
+
+      - id: pylint
+        name: pylint
+        entry: uv run pylint office365
+        language: system
+        pass_filenames: false
+
   - repo: https://github.com/psf/black
     rev: 23.9.1
     hooks:
       - id: black
         args:
-          - --quiet
+          - --quiet

README-dev.md

@@ -1,31 +1,27 @@
 # Installing to virtualenv
-In the pipenv/poetry era one would already forget these commands...
 
 ```bash
-$ python3 -m venv venv
-$ . venv/bin/activate
-$ pip install -r requirements.txt
-$ pip install -r requirements-dev.txt
+uv sync
 ```
 
-# Running tests
+## Running tests
 
-Most of the tests are end-to-end - operations are invoked against actual tenant (not mocked). 
-So one has to configure his/her office/sharepoint credentials. 
+Most of the tests are end-to-end - operations are invoked against actual tenant (not mocked).
+So one has to configure his/her office/sharepoint credentials.
 To do so, create a file ```.env``` like this (replace the bracketed values by your values):
 
-```
+```bash
 export office365_python_sdk_securevars='{username};{password};{client_id};{client_secret}'
 ```
 
 This file is in .gitignore, so it will never be committed.
 
 ```bash
-$ . .env   # source it to export the variable
-$ pytest ...  # run the test(s) you need...
+. .env   # source it to export the variable
+pytest ...  # run the test(s) you need...
 ```
 
-#### Configure Tenant
+## Configure Tenant
 
 Roles:
 

office365/entity_collection.py

@@ -3,6 +3,7 @@
 from typing_extensions import Self
 
 from office365.entity import Entity
+from office365.runtime.client_object import T
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.compat import is_string_type
 from office365.runtime.paths.resource_path import ResourcePath
@@ -12,8 +13,6 @@
 if TYPE_CHECKING:
     from office365.graph_client import GraphClient
 
-from office365.runtime.client_object import T
-
 
 class EntityCollection(ClientObjectCollection[T]):
     """A collection container which represents a named collections of entities"""

office365/py.typed

@@ -21,6 +21,7 @@ def __init__(self, context):
     def authenticate_request(self, request):
         pass
 
+    @property
     def service_root_url(self):
         return "{0}/_vti_bin/ExcelRest.aspx"
 

office365/sharepoint/excel/excel_rest.py

@@ -22,6 +22,7 @@ def __init__(self, context):
     def pending_request(self):
         return self._pending_request
 
+    @property
     def service_root_url(self):
         return self._service_root_url