Merge branch '909-make-bitbucket-ci-config-backend-agnostic' of https://github.com/nathanjmcdougall/usethis-python into 909-make-bitbucket-ci-config-backend-agnostic

nathanjmcdougall · nathanjmcdougall · commit 9d0dfad91c14 · 2025-10-14T05:45:09.000+13:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,7 +29,7 @@ jobs:
       PYTHONIOENCODING: utf-8
     steps:
       - name: Checkout code
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
 
@@ -39,13 +39,13 @@ jobs:
           git config --global user.email placeholder@example.com
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@f94ec6bedd8674c4426838e6b50417d36b6ab231 # v5.3.1
+        uses: astral-sh/setup-uv@3259c6206f993105e3a61b142c2d97bf4b9ef83d # v7.1.0
         with:
           version: ${{ matrix.uv_version || 'latest' }}
           enable-cache: true
 
       - name: Set up Python
-        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: ${{ matrix.python_version }}
 
@@ -69,7 +69,7 @@ jobs:
 
       - name: Run pytest
         uses: pavelzw/pytest-action@510c5e90c360a185039bea56ce8b3e7e51a16507 # v2.2.0
-        if: ${{ (matrix.pytest == null || matrix.pytest == 'true') && (github.event_name == 'schedule' || matrix.dependencies != 'max') }}
+        if: ${{ matrix.pytest == null || matrix.pytest == 'true' }}
         with:
           custom-pytest: uv run --frozen pytest
           custom-arguments: --cov --cov-report=xml --junitxml=junit.xml -o junit_family=legacy
@@ -83,7 +83,7 @@ jobs:
           run: uv run --frozen pytest --codspeed
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
+        uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
         if: ${{ matrix.codecov != null && matrix.codecov == 'true' }}
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
@@ -116,7 +116,7 @@ jobs:
             python_version: "3.10"
             uv_version: "0.6.8"
             pre_commit: "false"
-          - dependencies: "max" # Cron only (Pytest skipped)
+          - dependencies: "max"
             python_version: "3.14"
             pre_commit: "false"
           - codecov: "true"
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -27,15 +27,15 @@ jobs:
           - language: python
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@f443b600d91635bebf5b0d9ebc620189c0d6fba5 # v4.30.8
         with:
           languages: ${{ matrix.language }}
           build-mode: none
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
+        uses: github/codeql-action/analyze@f443b600d91635bebf5b0d9ebc620189c0d6fba5 # v4.30.8
         with:
           category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -15,18 +15,18 @@ jobs:
       id-token: write # Needed for trusted publishing
     steps:
       - name: Checkout code
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@3b9817b1bf26186f03ab8277bab9b827ea5cc254 # v3.2.0
+        uses: astral-sh/setup-uv@3259c6206f993105e3a61b142c2d97bf4b9ef83d # v7.1.0
         with:
           version: "latest"
           enable-cache: false
 
       - name: "Set up Python"
-        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: 3.12
 
diff --git a/README.md b/README.md
@@ -174,6 +174,8 @@ You could consider [this template](https://github.com/pawamoy/copier-uv) or [thi
 
 If you're using Cookiecutter, then you can update to a latest version of a template using a tool like [cruft](https://github.com/cruft/cruft). Copier has inbuilt support for template updating. Another template-style option which provides updating is [jaraco/skeleton](https://blog.jaraco.com/skeleton/), which is a specific, git-based template rather than a general templating system.
 
+If you're not interested in templating automations, then [configurator](https://github.com/jamesbraza/configurator) provides a list of useful tooling and configuration to consider for your Python projects.
+
 ## 🚀 Development
 
 [![Commits since latest release](https://img.shields.io/github/commits-since/usethis-python/usethis-python/latest.svg)](https://github.com/usethis-python/usethis-python/releases)
diff --git a/docs/similar-projects.md b/docs/similar-projects.md
@@ -11,3 +11,5 @@ You could consider [this template](https://github.com/pawamoy/copier-uv) or [thi
 You can still use usethis as a part of a templates using [hooks](https://cookiecutter.readthedocs.io/en/latest/advanced/hooks.html#using-pre-post-generate-hooks-0-7-0) for Cookiecutter and [tasks](https://copier.readthedocs.io/en/stable/configuring/#tasks) for Copier.
 
 If you're using Cookiecutter, then you can update to a latest version of a template using a tool like [cruft](https://github.com/cruft/cruft). Copier has inbuilt support for template updating. Another template-style option which provides updating is [jaraco/skeleton](https://blog.jaraco.com/skeleton/), which is a specific, git-based template rather than a general templating system.
+
+If you're not interested in templating automations, then [configurator](https://github.com/jamesbraza/configurator) provides a list of useful tooling and configuration to consider for your Python projects.
diff --git a/src/usethis/_core/tool.py b/src/usethis/_core/tool.py
@@ -117,6 +117,7 @@ def use_deptry(*, remove: bool = False, how: bool = False) -> None:
         else:
             tool.update_bitbucket_steps()
 
+        tool.add_configs()
         tool.print_how_to_use()
     else:
         tool.remove_pre_commit_repo_configs()
diff --git a/src/usethis/_tool/impl/deptry.py b/src/usethis/_tool/impl/deptry.py
@@ -73,7 +73,16 @@ def get_config_spec(self) -> ConfigSpec:
                 ConfigItem(
                     description="Overall config",
                     root={Path("pyproject.toml"): ConfigEntry(keys=["tool", "deptry"])},
-                )
+                ),
+                ConfigItem(
+                    description="Ignore notebooks",
+                    root={
+                        Path("pyproject.toml"): ConfigEntry(
+                            keys=["tool", "deptry", "ignore_notebooks"],
+                            get_value=lambda: False,
+                        )
+                    },
+                ),
             ],
         )
 
diff --git a/src/usethis/_toolset/lint.py b/src/usethis/_toolset/lint.py
@@ -2,5 +2,6 @@
 
 
 def use_linters(remove: bool = False, how: bool = False):
-    use_ruff(linter=True, formatter=False, remove=remove, how=how)
+    # Use deptry first since it determines that we use 'pyproject.toml' for Ruff.
     use_deptry(remove=remove, how=how)
+    use_ruff(linter=True, formatter=False, remove=remove, how=how)
diff --git a/tests/usethis/_core/test_core_tool.py b/tests/usethis/_core/test_core_tool.py
@@ -579,6 +579,18 @@ def test_dependency_added(self, uv_init_dir: Path):
                 (dev_dep,) = get_deps_from_group("dev")
             assert dev_dep == Dependency(name="deptry")
 
+        @pytest.mark.usefixtures("_vary_network_conn")
+        def test_ignore_notebooks(self, uv_init_dir: Path):
+            # Act
+            with change_cwd(uv_init_dir), PyprojectTOMLManager():
+                use_deptry()
+
+                # Assert
+                assert (
+                    PyprojectTOMLManager()[["tool", "deptry", "ignore_notebooks"]]
+                    is False
+                )
+
         @pytest.mark.usefixtures("_vary_network_conn")
         def test_stdout(
             self,
@@ -594,6 +606,7 @@ def test_stdout(
             assert out == (
                 "✔ Adding dependency 'deptry' to the 'dev' group in 'pyproject.toml'.\n"
                 "☐ Install the dependency 'deptry'.\n"
+                "✔ Adding deptry config to 'pyproject.toml'.\n"
                 "☐ Run 'uv run deptry src' to run deptry.\n"
             )
 
@@ -617,6 +630,7 @@ def test_stdout_unfrozen(
             out, _ = capfd.readouterr()
             assert out == (
                 "✔ Adding dependency 'deptry' to the 'dev' group in 'pyproject.toml'.\n"
+                "✔ Adding deptry config to 'pyproject.toml'.\n"
                 "☐ Run 'uv run deptry src' to run deptry.\n"
             )
 
@@ -693,6 +707,7 @@ def test_pre_commit_after(
             assert out == (
                 "✔ Adding dependency 'deptry' to the 'dev' group in 'pyproject.toml'.\n"
                 "☐ Install the dependency 'deptry'.\n"
+                "✔ Adding deptry config to 'pyproject.toml'.\n"
                 "☐ Run 'uv run deptry src' to run deptry.\n"
                 "✔ Adding dependency 'pre-commit' to the 'dev' group in 'pyproject.toml'.\n"
                 "☐ Install the dependency 'pre-commit'.\n"
@@ -854,6 +869,7 @@ def test_pre_commit_first(
                 "✔ Adding dependency 'deptry' to the 'dev' group in 'pyproject.toml'.\n"
                 "☐ Install the dependency 'deptry'.\n"
                 "✔ Adding hook 'deptry' to '.pre-commit-config.yaml'.\n"
+                "✔ Adding deptry config to 'pyproject.toml'.\n"
                 "☐ Run 'uv run deptry src' to run deptry.\n"
             )
 
@@ -886,6 +902,7 @@ def test_placeholder_removed(
                 "✔ Adding dependency 'deptry' to the 'dev' group in 'pyproject.toml'.\n"
                 "☐ Install the dependency 'deptry'.\n"
                 "✔ Adding hook 'deptry' to '.pre-commit-config.yaml'.\n"
+                "✔ Adding deptry config to 'pyproject.toml'.\n"
                 "☐ Run 'uv run deptry src' to run deptry.\n"
             )
 
diff --git a/tests/usethis/_core/test_rule.py b/tests/usethis/_core/test_rule.py
@@ -40,6 +40,7 @@ def test_deptry_rule_selected(
         assert out == (
             "✔ Adding dependency 'deptry' to the 'dev' group in 'pyproject.toml'.\n"
             "☐ Install the dependency 'deptry'.\n"
+            "✔ Adding deptry config to 'pyproject.toml'.\n"
             "☐ Run 'uv run deptry src' to run deptry.\n"
             "ℹ All deptry rules are always implicitly selected.\n"  # noqa: RUF001
         )
diff --git a/tests/usethis/_tool/impl/test_deptry.py b/tests/usethis/_tool/impl/test_deptry.py
@@ -21,8 +21,8 @@ def test_get_pyproject_id_keys(self):
         result = tool.get_config_spec()
 
         # Assert
-        (config_item,) = result.config_items
-        config_item: ConfigItem
+        config_item, *_ = result.config_items
+        assert isinstance(config_item, ConfigItem)
         assert config_item.root[Path("pyproject.toml")] == ConfigEntry(
             keys=["tool", "deptry"]
         )
@@ -256,7 +256,7 @@ def test_empty_dir(self, tmp_path: Path):
                 DeptryTool().add_configs()
 
             # Assert
-            assert not (tmp_path / "pyproject.toml").exists()
+            assert (tmp_path / "pyproject.toml").exists()
 
         def test_pyproject_toml_exists(self, tmp_path: Path):
             # Arrange
diff --git a/tests/usethis/_ui/interface/test_init.py b/tests/usethis/_ui/interface/test_init.py
@@ -33,8 +33,8 @@ def test_pre_commit_included(self, tmp_path: Path):
             "☐ Run 'uv run mkdocs build' to build the documentation.\n"
             "☐ Run 'uv run mkdocs serve' to serve the documentation locally.\n"
             "✔ Adding recommended linters.\n"
-            "☐ Run 'uv run ruff check --fix' to run the Ruff linter with autofixes.\n"
             "☐ Run 'uv run deptry src' to run deptry.\n"
+            "☐ Run 'uv run ruff check --fix' to run the Ruff linter with autofixes.\n"
             "✔ Adding recommended formatters.\n"
             "☐ Run 'uv run ruff format' to run the Ruff formatter.\n"
             "☐ Run 'uv run pre-commit run pyproject-fmt --all-files' to run pyproject-fmt.\n"
@@ -86,8 +86,8 @@ def test_readme_example(self, tmp_path: Path):
 ☐ Run 'uv run mkdocs build' to build the documentation.
 ☐ Run 'uv run mkdocs serve' to serve the documentation locally.
 ✔ Adding recommended linters.
-☐ Run 'uv run ruff check --fix' to run the Ruff linter with autofixes.
 ☐ Run 'uv run deptry src' to run deptry.
+☐ Run 'uv run ruff check --fix' to run the Ruff linter with autofixes.
 ✔ Adding recommended formatters.
 ☐ Run 'uv run ruff format' to run the Ruff formatter.
 ☐ Run 'uv run pyproject-fmt pyproject.toml' to run pyproject-fmt.
@@ -157,8 +157,8 @@ def test_bitbucket_docstyle_and_status(self, tmp_path: Path):
             "☐ Run 'uv run mkdocs build' to build the documentation.\n"
             "☐ Run 'uv run mkdocs serve' to serve the documentation locally.\n"
             "✔ Adding recommended linters.\n"
-            "☐ Run 'uv run ruff check --fix' to run the Ruff linter with autofixes.\n"
             "☐ Run 'uv run deptry src' to run deptry.\n"
+            "☐ Run 'uv run ruff check --fix' to run the Ruff linter with autofixes.\n"
             "✔ Adding recommended formatters.\n"
             "☐ Run 'uv run ruff format' to run the Ruff formatter.\n"
             "☐ Run 'uv run pre-commit run pyproject-fmt --all-files' to run pyproject-fmt.\n"
@@ -193,8 +193,8 @@ def test_none_backend(self, tmp_path: Path):
             "☐ Run 'mkdocs build' to build the documentation.\n"
             "☐ Run 'mkdocs serve' to serve the documentation locally.\n"
             "✔ Adding recommended linters.\n"
-            "☐ Run 'ruff check --fix' to run the Ruff linter with autofixes.\n"
             "☐ Run 'deptry src' to run deptry.\n"
+            "☐ Run 'ruff check --fix' to run the Ruff linter with autofixes.\n"
             "✔ Adding recommended formatters.\n"
             "☐ Run 'ruff format' to run the Ruff formatter.\n"
             "☐ Run 'pyproject-fmt pyproject.toml' to run pyproject-fmt.\n"
diff --git a/tests/usethis/_ui/interface/test_lint.py b/tests/usethis/_ui/interface/test_lint.py
@@ -33,16 +33,17 @@ def test_none_backend_no_pyproject_toml(self, tmp_path: Path):
 
         # Assert
         assert result.exit_code == 0, result.output
-        assert not (tmp_path / "pyproject.toml").exists()
+        assert (tmp_path / "pyproject.toml").exists()  # from deptry config
         assert result.output.replace("\n", "") == (
-            "☐ Add the dev dependency 'ruff'.\n"
-            "✔ Writing 'ruff.toml'.\n"
-            "✔ Adding Ruff config to 'ruff.toml'.\n"
-            "✔ Selecting Ruff rules 'A', 'C4', 'E4', 'E7', 'E9', 'F', 'FLY', 'FURB', 'I', 'PLE', 'PLR', 'RUF', 'SIM', 'UP' in 'ruff.toml'.\n"
-            "✔ Ignoring Ruff rules 'PLR2004', 'SIM108' in 'ruff.toml'.\n"
-            "☐ Run 'ruff check --fix' to run the Ruff linter with autofixes.\n"
             "☐ Add the dev dependency 'deptry'.\n"
+            "✔ Writing 'pyproject.toml'.\n"
+            "✔ Adding deptry config to 'pyproject.toml'.\n"
             "☐ Run 'deptry .' to run deptry.\n"
+            "☐ Add the dev dependency 'ruff'.\n"
+            "✔ Adding Ruff config to 'pyproject.toml'.\n"
+            "✔ Selecting Ruff rules 'A', 'C4', 'E4', 'E7', 'E9', 'F', 'FLY', 'FURB', 'I', 'PLE', 'PLR', 'RUF', 'SIM', 'UP' in 'pyproject.toml'.\n"
+            "✔ Ignoring Ruff rules 'PLR2004', 'SIM108' in 'pyproject.toml'.\n"
+            "☐ Run 'ruff check --fix' to run the Ruff linter with autofixes.\n"
         ).replace("\n", "")
 
     def test_none_backend_pyproject_toml(self, tmp_path: Path):
@@ -58,11 +59,12 @@ def test_none_backend_pyproject_toml(self, tmp_path: Path):
         assert result.exit_code == 0, result.output
         assert (tmp_path / "pyproject.toml").exists()
         assert result.output.replace("\n", "") == (
+            "☐ Add the dev dependency 'deptry'.\n"
+            "✔ Adding deptry config to 'pyproject.toml'.\n"
+            "☐ Run 'deptry .' to run deptry.\n"
             "☐ Add the dev dependency 'ruff'.\n"
             "✔ Adding Ruff config to 'pyproject.toml'.\n"
             "✔ Selecting Ruff rules 'A', 'C4', 'E4', 'E7', 'E9', 'F', 'FLY', 'FURB', 'I', 'PLE', 'PLR', 'RUF', 'SIM', 'UP' in 'pyproject.toml'.\n"
             "✔ Ignoring Ruff rules 'PLR2004', 'SIM108' in 'pyproject.toml'.\n"
             "☐ Run 'ruff check --fix' to run the Ruff linter with autofixes.\n"
-            "☐ Add the dev dependency 'deptry'.\n"
-            "☐ Run 'deptry .' to run deptry.\n"
         ).replace("\n", "")

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ def test_deptry_rule_selected(`
`40`	`40`	`assert out == (`
`41`	`41`	`"✔ Adding dependency 'deptry' to the 'dev' group in 'pyproject.toml'.\n"`
`42`	`42`	`"☐ Install the dependency 'deptry'.\n"`
	`43`	`+ "✔ Adding deptry config to 'pyproject.toml'.\n"`
`43`	`44`	`"☐ Run 'uv run deptry src' to run deptry.\n"`
`44`	`45`	`"ℹ All deptry rules are always implicitly selected.\n" # noqa: RUF001`
`45`	`46`	`)`