Use uv and ruff

.github/workflows/ci.yml

@@ -12,17 +12,19 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version-file: "pyproject.toml"
 
-      - name: Install dependencies
-        shell: bash
-        run: |
-          python -m pip install --upgrade pip
-          pip install pytest
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Update environment
+        run: uv sync --all-extras --dev
 
-      # TODO: add linter(s) (ruff, black, flake8, etc.)
+      - name: Lint
+        run: uv run ruff check
 
-      - run: pytest
+      - name: Run tests
+        run: uv run pytest

README.md

@@ -28,6 +28,7 @@ TODO:
 * Put tests in separate directory
 * Configure Ruff linter
 * Verify load balancer strategies (sticky session)
+* Dependabot [dependabot#10039](https://github.com/dependabot/dependabot-core/issues/10039)
 
 ## Modules
 
@@ -70,14 +71,37 @@ TODO:
 
 ## Local development
 
+Use VS Code with the following extensions:
+
+* Python
+* Ruff
+
+Update environment:
+
+```shell
+uv sync
+```
+
 Execute the following commands to run the application locally:
 
 ```shell
 streamlit run app.py
 ```
 
+Check formatting:
+
+```shell
+ruff check
+```
+
 Execute tests:
 
 ```shell
 pytest
 ```
+
+Show outdated dependencies:
+
+```shell
+uv pip list --outdated
+```

example/service/nyc_tlc_trips.py

@@ -1,18 +1,11 @@
 from datetime import date
 
 import pandas as pd
-
 import streamlit as st
+
 from example.infrastructure import big_query
 
-_PAYMENT_TYPES = {
-    "1": "Credit card",
-    "2": "Cash",
-    "3": "No charge",
-    "4": "Dispute",
-    "5": "Unknown",
-    "6": "Voided trip"
-}
+_PAYMENT_TYPES = {"1": "Credit card", "2": "Cash", "3": "No charge", "4": "Dispute", "5": "Unknown", "6": "Voided trip"}
 
 
 @st.cache_data(ttl=600)
@@ -38,7 +31,7 @@ def get_trips(date_range: tuple[date, date], payment_type: str) -> pd.DataFrame:
     params = {
         "start_date": date_range[0].isoformat(),
         "end_date": date_range[1].isoformat(),
-        "payment_type": _get_payment_type_key(payment_type)
+        "payment_type": _get_payment_type_key(payment_type),
     }
 
     results = big_query.query(query, params)

example/ui/components/authentication.py

@@ -1,5 +1,6 @@
 import streamlit as st
 
+
 def login() -> None:
     st.session_state["logged_in"] = True
     st.session_state["username"] = "John Doe"

example/ui/components/date_range_picker.py

@@ -12,7 +12,9 @@
 def show(key: str = "date_range_picker") -> tuple[date, date]:
     __initialize_state(key)
 
-    date_range = st.date_input("Select date range", min_value=_MIN_DATE, max_value=_MAX_DATE, value=st.session_state[key])
+    value = st.session_state[key]
+
+    date_range = st.date_input("Select date range", min_value=_MIN_DATE, max_value=_MAX_DATE, value=value)
 
     if len(date_range) == 2:
         st.session_state[key] = date_range

example/ui/components/payment_type_selector.py

@@ -6,7 +6,9 @@
 def show(key: str = "payment_type_selector") -> str:
     __initialize_state(key)
 
-    payment_type = st.selectbox("Payment type", _PAYMENT_TYPE_OPTIONS, index=_PAYMENT_TYPE_OPTIONS.index(st.session_state[key]))
+    index = _PAYMENT_TYPE_OPTIONS.index(st.session_state[key])
+
+    payment_type = st.selectbox("Payment type", _PAYMENT_TYPE_OPTIONS, index=index)
     st.session_state[key] = payment_type
 
     return st.session_state[key]

example/ui/pages/home.py

@@ -1,7 +1,6 @@
 import streamlit as st
 
-from example.ui.components import date_range_picker
-from example.ui.components import payment_type_selector
+from example.ui.components import date_range_picker, payment_type_selector
 
 st.title("Home")
 st.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit")

example/ui/pages/page2.py

@@ -1,7 +1,6 @@
 import streamlit as st
 
-from example.ui.components import date_range_picker
-from example.ui.components import payment_type_selector
+from example.ui.components import date_range_picker, payment_type_selector
 
 st.title("Page 2")
 

example/ui/pages/page3.py

@@ -1,8 +1,7 @@
 import streamlit as st
 
 from example.service import nyc_tlc_trips
-from example.ui.components import date_range_picker
-from example.ui.components import payment_type_selector
+from example.ui.components import date_range_picker, payment_type_selector
 
 st.title("Page 3")
 

example/ui/pages/page4.py

@@ -1,7 +1,6 @@
 import streamlit as st
 
-from example.ui.components import date_range_picker
-from example.ui.components import payment_type_selector
+from example.ui.components import date_range_picker, payment_type_selector
 
 st.title("Page 4")
 

example/ui/pages/test_login.py

@@ -13,5 +13,5 @@ def test_login_button_click():
 
     at.button[0].click().run()
 
-    assert at.session_state["logged_in"] == True
+    assert at.session_state["logged_in"] is True
     assert at.session_state["username"] == "John Doe"

example/ui/pages/test_page3.py

@@ -4,6 +4,7 @@
 import pandas.testing as pdt
 from streamlit.testing.v1 import AppTest
 
+
 @patch("example.service.nyc_tlc_trips.get_trips")
 def test_show_title(mock_get_trips):
     trips = pd.DataFrame()
@@ -13,16 +14,19 @@ def test_show_title(mock_get_trips):
 
     assert at.title[0].value == "Page 3"
 
+
 @patch("example.service.nyc_tlc_trips.get_trips")
 def test_show_trips(mock_get_trips):
-    trips = pd.DataFrame({
-        'day': ['2023-01-01'],
-        'payment_type': 'Credit card',
-        'total_fare': [100.0],
-        'total_tips': [10.0],
-        'total_amount': [110.0],
-        'trip_count': [1]
-    })
+    trips = pd.DataFrame(
+        {
+            "day": ["2023-01-01"],
+            "payment_type": "Credit card",
+            "total_fare": [100.0],
+            "total_tips": [10.0],
+            "total_amount": [110.0],
+            "trip_count": [1],
+        }
+    )
     mock_get_trips.return_value = trips
 
     at = AppTest.from_file("page3.py").run()

pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "example-streamlit"
+description = "Non-trivial Streamlit application skeleton implemented in a 'Streamlit way'"
+version = "1.0.0"
+requires-python = "~=3.12"
+
+dependencies = [
+    "streamlit==1.39.0",
+    # bigquery integration
+    "google-cloud-bigquery==3.25.0",
+    "db-dtypes==1.3.1",
+]
+
+[tool.uv]
+dev-dependencies = [
+    "pytest==8.3.3",
+    # linter and formatter
+    "ruff==0.7.4",
+    # speedup source code monitoring and live reloading
+    "watchdog==2.1.6",
+]
+
+[tool.pytest.ini_options]
+pythonpath = "."
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E", # pycodestyle errors
+    "W", # pycodestyle warnings
+    "F", # pyflakes
+    "I", # isort
+    "B", # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]

test_app.py

@@ -19,6 +19,7 @@ def test_show_app_authenticated():
     assert at.button[0].label == "Share"
     assert at.button[1].label == "Log out"
 
+
 def test_logout_button_click():
     at = AppTest.from_file("app.py")
     at.session_state["logged_in"] = True
@@ -27,7 +28,7 @@ def test_logout_button_click():
 
     at.button[1].click().run()
 
-    assert at.session_state["logged_in"] == False
+    assert at.session_state["logged_in"] is False
     assert at.session_state["username"] is None
 
 
@@ -39,6 +40,7 @@ def test_decode_valid_state():
     assert at.session_state["k1"] == "v1"
     assert at.session_state["k2"] == "v2"
 
+
 def test_decode_and_merge_valid_state():
     at = AppTest.from_file("app.py")
     at.session_state["k1"] = "v1"