Merge pull request #9 from IsaacCheng9/convert-to-uv

Convert from Poetry to UV

Author: IsaacCheng9

.github/workflows/format.yml

@@ -2,30 +2,26 @@ name: Format
 
 on: [push]
 
+permissions:
+  contents: write
+
 jobs:
   format:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [3.14.x]
-
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Run Python code formatting with Black
-        uses: lgeiger/black-action@v1.0.1
+      - name: Ruff format
+        uses: astral-sh/ruff-action@v3
         with:
-          args: "."
+          args: format
 
-      - name: Commit changes made by Black
-        uses: stefanzweifel/git-auto-commit-action@v5
+      - name: Ruff lint (fix)
+        uses: astral-sh/ruff-action@v3
         with:
-          commit_message: Format Python code with Black
-
-      - name: Switch to current branch
-        run: git checkout ${{ env.BRANCH }}
+          args: check --fix
 
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3.1.4
+      - name: Commit changes made by Ruff
+        uses: stefanzweifel/git-auto-commit-action@master
         with:
-          python-version: ${{ matrix.python-version }}
+          commit_message: Format Python code with Ruff

.github/workflows/test.yml

@@ -1,45 +1,36 @@
-name: test
+name: Test
 
-# Controls when the action will run.
 on:
-  # Triggers the workflow on push events but only for the main branch.
   push:
-  # Allows you to run this workflow manually from the Actions tab.
   workflow_dispatch:
 
 jobs:
   test:
-    # The type of runner that the job will run on.
     runs-on: ubuntu-latest
-    # Configures the build to use the latest version of Python 3.
     strategy:
       matrix:
-        python-version: [3.14.x]
+        python-version:
+          - "3.14.x"
 
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can
-      # access it.
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@main
 
       - name: Switch to current branch
         run: git checkout ${{ env.BRANCH }}
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@main
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install Poetry
-        run: |
-          python -m pip install --upgrade pip
-          pip install poetry
+      - name: Install uv
+        uses: astral-sh/setup-uv@main
 
-      - name: Install Python dependencies with Poetry
-        run: |
-          poetry install
+      - name: Install the project
+        run: uv sync --all-extras --dev
 
-      - name: Run unit tests with Pytest
-        run: poetry run coverage run --source=src/boruvkas_algorithm -m pytest -v
+      - name: Run tests with Pytest
+        run: uv run coverage run --source=src/boruvkas_algorithm/ -m pytest -v
 
       - name: Get code coverage report
-        run: poetry run coverage report -m
+        run: uv run coverage report -m

README.md

@@ -1,13 +1,14 @@
 # Boruvka's Algorithm
 
-[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Test](https://github.com/IsaacCheng9/boruvkas-algorithm/actions/workflows/test.yml/badge.svg)](https://github.com/IsaacCheng9/boruvkas-algorithm/actions/workflows/test.yml)
 
-An implementation of Boruvka's algorithm to find a minimum spanning tree in a graph.
+An implementation of Boruvka's algorithm to find a minimum spanning tree in a
+graph.
 
 [Link to narrated video demonstration on YouTube.](https://www.youtube.com/watch?v=n5LNVobuBNU)
 
 ## Example
+
 <img width="481" alt="image" src="https://github.com/IsaacCheng9/boruvkas-algorithm/assets/47993930/70c6d09e-7273-4416-8194-f4fe37701ef2">
 
 <details>
@@ -61,30 +62,33 @@ MST edges (node1, node2, weight):
     (7, 8, 3)
 MST weight: 29
 ```
+
 </details>
 
 ## Usage
 
 ### Installing Dependencies
 
+Install [uv](https://docs.astral.sh/uv/) if you haven't already.
+
 Run the following command from the [project root](./) directory:
 
 ```bash
-poetry install
+uv sync --dev
 ```
 
 ### Running the Application
 
 Run the following command from the [project root](./) directory:
 
 ```bash
-poetry run app
+uv run python -m src.boruvkas_algorithm.boruvka
 ```
 
 ### Running Tests
 
 Run the following command from the [project root](./) directory:
 
 ```bash
-poetry run pytest
+uv run pytest -v
 ```