Configure ruff and UV

.github/workflows/lint.yaml

@@ -6,21 +6,30 @@ on:
 
 name: lint
 
+env:
+  PYTHONUNBUFFERED: "1"
+  UV_SYSTEM_PYTHON: 1
+
 jobs:
   lint-ruff:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup python
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: pyproject.toml
+
+      - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.x"
-          cache: "pip"
+          python-version-file: pyproject.toml
 
       - name: Install dependencies
-        run: pip install . ruff
+        run: uv pip install . ruff
 
       - name: Lint with ruff
         run: ruff check --output-format=github .

.github/workflows/pages.yaml

@@ -7,6 +7,10 @@ on:
 
 name: pages
 
+env:
+  PYTHONUNBUFFERED: "1"
+  UV_SYSTEM_PYTHON: 1
+
 jobs:
   build-sphinx-site:
     runs-on: ubuntu-latest
@@ -17,18 +21,23 @@ jobs:
       - name: Configure pages
         uses: actions/configure-pages@v5
 
-      - name: Setup python
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: pyproject.toml
+          cache-suffix: docs
+
+      - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.x"
-          cache: "pip"
+          python-version-file: pyproject.toml
 
-      - name: Install dependencies
-        run: pip install .[docs]
+      - name: Install Python dependencies
+        run: uv pip install .[docs]
 
       - name: Generate HTML
-        run: |
-          sphinx-build -d _build/doctrees docs/source _build/html
+        run: sphinx-build -d _build/doctrees docs/source _build/html
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

.github/workflows/pre-commit.yaml

@@ -5,6 +5,10 @@ on:
 
 name: pre-commit
 
+env:
+  PYTHONUNBUFFERED: "1"
+  UV_SYSTEM_PYTHON: 1
+
 jobs:
   pre-commit:
     runs-on: ubuntu-latest

.github/workflows/pypi-publish.yaml

@@ -5,6 +5,10 @@ on:
 
 name: pypi-publish
 
+env:
+  PYTHONUNBUFFERED: "1"
+  UV_SYSTEM_PYTHON: 1
+
 jobs:
   pypi-publish:
     name: pypi-publish
@@ -18,16 +22,22 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: pyproject.toml
+
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.x"
+          python-version-file: pyproject.toml
 
-      - name: Install dependencies
-        run: pip install build
+      - name: Install Python dependencies
+        run: uv pip install .
 
       - name: Build Python dist
-        run: python -m build
+        run: uv build
 
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/python-package.yaml

@@ -18,14 +18,24 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup python ${{ matrix.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: pyproject.toml
+
+      - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: "pip"
 
       - name: Install tox
-        run: pip install tox-gh>=1.3.0
+        shell: bash
+        run: |
+          uv tool install tox --with tox-uv
+          tox --version
 
       - name: Test install with tox
-        run: tox -v --notest
+        run: |
+          env=$(echo ${{ matrix.python-version }} | tr -d '.' | sed 's/^/py/')
+          tox r -v --notest -e "$env"

.github/workflows/test-coverage.yaml

@@ -6,6 +6,10 @@ on:
 
 name: test-coverage
 
+env:
+  PYTHONUNBUFFERED: "1"
+  UV_SYSTEM_PYTHON: 1
+
 jobs:
   test-coverage:
     runs-on: ubuntu-latest
@@ -18,14 +22,20 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup python ${{ matrix.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: pyproject.toml
+          cache-suffix: test
+
+      - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: "pip"
 
       - name: Install dependencies
-        run: pip install .[test]
+        run: uv pip install .[test]
 
       - name: Run pytest
         run: |

.pre-commit-config.yaml

@@ -1,6 +1,8 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.5
+    rev: v0.7.2
     hooks:
       - id: ruff
+        args:
+          - --fix
       - id: ruff-format

assesspy/__init__.py

@@ -6,19 +6,19 @@
 from .formulas import (
     cod,
     cod_met,
+    ki,
+    mki,
+    mki_met,
     prb,
     prb_met,
     prd,
     prd_met,
-    ki,
-    mki,
-    mki_met,
 )
+from .load_data import ratios_sample
 from .outliers import (
     iqr_outlier,
     is_outlier,
     quantile_outlier,
 )
-from .load_data import ratios_sample
 from .sales_chasing import detect_chasing
 from .utils import check_inputs

assesspy/ci.py

@@ -54,10 +54,12 @@ def boot_ci(fun, nboot=100, alpha=0.05, **kwargs):
         kwargs.keys()
     ):
         kwargs = (kwargs["assessed"], kwargs["sale_price"])
-    elif fun.__name__ == "prd" and not set(["assessed", "sale_price"]).issubset(
-        kwargs.keys()
-    ):
-        raise Exception("PRD function expects argurments 'assessed' and 'sale_price'.")
+    elif fun.__name__ == "prd" and not set(
+        ["assessed", "sale_price"]
+    ).issubset(kwargs.keys()):
+        raise Exception(
+            "PRD function expects argurments 'assessed' and 'sale_price'."
+        )
     else:
         kwargs = tuple(kwargs.values())
 

assesspy/formulas.py

@@ -165,7 +165,10 @@ def prb(assessed, sale_price, round=None):
     prb_ci = prb_model.conf_int(alpha=0.05)[0].tolist()
 
     if round is not None:
-        out = {"prb": np.round(prb_val, round), "95% ci": np.round(prb_ci, round)}
+        out = {
+            "prb": np.round(prb_val, round),
+            "95% ci": np.round(prb_ci, round),
+        }
 
     else:
         out = {"prb": prb_val, "95% ci": prb_ci}

assesspy/load_data.py

@@ -23,5 +23,7 @@ def ratios_sample():
     :rtype: DataFrame
     """
 
-    stream = pkg_resources.resource_stream(__name__, "data/ratios_sample.parquet")
+    stream = pkg_resources.resource_stream(
+        __name__, "data/ratios_sample.parquet"
+    )
     return pd.read_parquet(stream)

assesspy/outliers.py

@@ -96,7 +96,9 @@ def is_outlier(x, method="iqr", probs=[0.05, 0.95]):
         ap.is_outlier(ap.ratios_sample().ratio)
     """
 
-    out = {"iqr": iqr_outlier(x), "quantile": quantile_outlier(x, probs)}.get(method)
+    out = {"iqr": iqr_outlier(x), "quantile": quantile_outlier(x, probs)}.get(
+        method
+    )
 
     # Warn about removing data from small samples, as it can severely distort
     # ratio study outcomes

assesspy/sales_chasing.py

@@ -27,7 +27,9 @@ def detect_chasing_cdf(ratio, bounds=[0.98, 1.02], cdf_gap=0.03):
     # Check if the largest difference is greater than the threshold and make
     # sure it's within the specified boundaries
     diff_loc = sorted_ratio[np.argmax(diffs)]
-    out = (max(diffs) > cdf_gap) & ((diff_loc > bounds[0]) & (diff_loc < bounds[1]))
+    out = (max(diffs) > cdf_gap) & (
+        (diff_loc > bounds[0]) & (diff_loc < bounds[1])
+    )
 
     return out
 

assesspy/tests/test_formulas.py

@@ -162,7 +162,9 @@ def test_prb_met(self):  # Standard met function
         gini_data_sale.append(first_column)
         gini_data_assessed.append(second_column)
 
-gini_data_assessed = [int(value.replace('"', "")) for value in gini_data_assessed]
+gini_data_assessed = [
+    int(value.replace('"', "")) for value in gini_data_assessed
+]
 gini_data_sale = [int(value.replace('"', "")) for value in gini_data_sale]
 
 mki_out = assesspy.mki(gini_data_assessed, gini_data_sale)

docs/source/conf.py

@@ -1,5 +1,6 @@
 import os
 import sys
+
 from sphinx_pyproject import SphinxConfig
 
 sys.path.append(os.path.abspath("../.."))