Add uv badge and badge tests (#460)

* Add uv badge and badge tests

* Add test coverage for adding uv badge in `usethis readme`

Author: nathanjmcdougall

src/usethis/_core/badge.py

@@ -32,6 +32,12 @@ def equivalent_to(self, other: Self) -> bool:
         return self.name == other.name
 
 
+def get_pre_commit_badge() -> Badge:
+    return Badge(
+        markdown="[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)"
+    )
+
+
 def get_pypi_badge() -> Badge:
     try:
         name = get_name()
@@ -53,9 +59,9 @@ def get_ruff_badge() -> Badge:
     )
 
 
-def get_pre_commit_badge() -> Badge:
+def get_uv_badge() -> Badge:
     return Badge(
-        markdown="[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)"
+        markdown="[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)"
     )
 
 
@@ -68,6 +74,7 @@ def get_usethis_badge() -> Badge:
 def get_badge_order() -> list[Badge]:
     return [
         get_pypi_badge(),
+        get_uv_badge(),
         get_ruff_badge(),
         get_pre_commit_badge(),
         get_usethis_badge(),

src/usethis/_interface/badge.py

@@ -8,6 +8,7 @@
     get_pypi_badge,
     get_ruff_badge,
     get_usethis_badge,
+    get_uv_badge,
     remove_badge,
 )
 
@@ -68,3 +69,16 @@ def usethis(
             add_badge(get_usethis_badge())
         else:
             remove_badge(get_usethis_badge())
+
+
+@app.command(help="Add a badge for the uv package manager.")
+def uv(
+    remove: bool = remove_opt,
+    offline: bool = offline_opt,
+    quiet: bool = quiet_opt,
+) -> None:
+    with usethis_config.set(offline=offline, quiet=quiet), files_manager():
+        if not remove:
+            add_badge(get_uv_badge())
+        else:
+            remove_badge(get_uv_badge())

src/usethis/_interface/readme.py

@@ -9,8 +9,10 @@
     get_pre_commit_badge,
     get_ruff_badge,
     get_usethis_badge,
+    get_uv_badge,
 )
 from usethis._core.readme import add_readme
+from usethis._integrations.uv.used import is_uv_used
 from usethis._tool import PreCommitTool, RuffTool
 
 
@@ -28,4 +30,7 @@ def readme(
             if PreCommitTool().is_used():
                 add_badge(get_pre_commit_badge())
 
+            if is_uv_used():
+                add_badge(get_uv_badge())
+
             add_badge(get_usethis_badge())

tests/usethis/_interface/test_interface_badge.py

@@ -73,3 +73,49 @@ def test_remove(self, tmp_path: Path):
 
         # Assert
         assert result.exit_code == 0, result.output
+
+
+class TestUsethis:
+    def test_add(self, tmp_path: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["usethis"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+
+    def test_remove(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "README.md").write_text("")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["usethis", "--remove"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+
+
+class TestUV:
+    def test_add(self, tmp_path: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["uv"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+
+    def test_remove(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "README.md").write_text("")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["uv", "--remove"])
+
+        # Assert
+        assert result.exit_code == 0, result.output

tests/usethis/_interface/test_interface_readme.py

@@ -23,6 +23,7 @@ def test_badges(self, tmp_path: Path):
         # Arrange
         (tmp_path / "ruff.toml").touch()
         (tmp_path / ".pre-commit-config.yaml").touch()
+        (tmp_path / "uv.lock").write_text("")
 
         # Act
         runner = CliRunner()
@@ -35,3 +36,4 @@ def test_badges(self, tmp_path: Path):
         # and check the badges get created
         assert "ruff" in (tmp_path / "README.md").read_text()
         assert "pre-commit" in (tmp_path / "README.md").read_text()
+        assert "uv" in (tmp_path / "README.md").read_text()