duty 1.5.0__tar.gz → 1.6.0__tar.gz

{duty-1.5.0 → duty-1.6.0}/CHANGELOG.md

@@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.6.0](https://github.com/pawamoy/duty/releases/tag/1.6.0) - 2025-03-01
+
+<small>[Compare with 1.5.0](https://github.com/pawamoy/duty/compare/1.5.0...1.6.0)</small>
+
+### Features
+
+- Add Yore tool ([4cbb478](https://github.com/pawamoy/duty/commit/4cbb478ac41258316188fcd3402e5165b0c233ac) by Timothée Mazzucotelli).
+
 ## [1.5.0](https://github.com/pawamoy/duty/releases/tag/1.5.0) - 2025-02-02
 
 <small>[Compare with 1.4.3](https://github.com/pawamoy/duty/compare/1.4.3...1.5.0)</small>

{duty-1.5.0 → duty-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: duty
-Version: 1.5.0
+Version: 1.6.0
 Summary: A simple task runner.
 Keywords: task-runner,task,runner,cross-platform
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>

{duty-1.5.0 → duty-1.6.0}/docs/usage.md

@@ -54,18 +54,17 @@ def docs(ctx):
     # avoid the overhead of an extra Python process
 ```
 
-For convenience, `duty` provides callables for many popular Python tools,
+For convenience, `duty` provides callables (called "tools") for many popular Python tools,
 so that you don't have to read their source and learn how to call them.
 For example, the `mkdocs build` command can be called like this:
 
 ```python
-from duty import duty
-from duty.callables import mkdocs
+from duty import duty, tools
 
 
 @duty
 def docs(ctx):
-    ctx.run(mkdocs.build, kwargs={"strict": True}, title="Building documentation")
+    ctx.run(tool.mkdocs.build, kwargs={"strict": True}, title="Building documentation")
 ```
 
 ### Lazy callables
@@ -78,19 +77,18 @@ without passing arguments and keyword arguments
 with the `args` and `kwargs` parameters of `ctx.run()`:
 
 ```python
-from duty import duty
-from duty.callables import mkdocs
+from duty import duty, tools
 
 
 @duty
 def docs(ctx):
-    ctx.run(mkdocs.build(strict=True), title="Building documentation")
+    ctx.run(tools.mkdocs.build(strict=True), title="Building documentation")
 ```
 
 The main benefit is that it enables IDE features like help tooltips and auto-completion,
 as well as improving readability and writability.
 
-**[See all our callables in the Code reference][duty.tools].**
+**[See all our tools in the Code reference][duty.tools].**
 
 You can also create your own lazy callables with [`duty.tools.Tool`][]
 and [`duty.tools.lazy`][failprint.lazy.lazy].

{duty-1.5.0 → duty-1.6.0}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "failprint>=0.11,!=1.0.0",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "1.5.0"
+version = "1.6.0"
 
 [project.license]
 text = "ISC"

{duty-1.5.0 → duty-1.6.0}/src/duty/completions.bash

@@ -1,18 +1,18 @@
-# Invoke tab-completion script to be sourced with Bash shell.
-# Known to work on Bash 3.x, untested on 4.x.
+# Taken and adapted from pyinvoke:
+# Copyright (c) 2020 Jeff Forcier.
+# All rights reserved.
 
 _complete_duty() {
     local candidates
 
-    # COMP_WORDS contains the entire command string up til now (including
-    # program name).
-    # We hand it to Invoke so it can figure out the current context: spit back
-    # core options, task names, the current task's options, or some combo.
+    # COMP_WORDS contains the entire command string up til now (including # program name).
+    # We hand it to Invoke so it can figure out the current context:
+    # spit back core options, task names, the current task's options, or some combo.
     candidates=$(duty --complete -- "${COMP_WORDS[@]}")
 
-    # `compgen -W` takes list of valid options & a partial word & spits back
-    # possible matches. Necessary for any partial word completions (vs
-    # completions performed when no partial words are present).
+    # `compgen -W` takes list of valid options & a partial word & spits back possible matches.
+    # Necessary for any partial word completions
+    # (vs. completions performed when no partial words are present).
     #
     # $2 is the current word or token being tabbed on, either empty string or a
     # partial word, and thus wants to be compgen'd to arrive at some subset of

{duty-1.5.0 → duty-1.6.0}/src/duty/tools/__init__.py

@@ -22,6 +22,7 @@ from duty.tools._ruff import ruff
 from duty.tools._safety import safety
 from duty.tools._ssort import ssort
 from duty.tools._twine import twine
+from duty.tools._yore import yore
 
 __all__ = [
     "LazyStderr",
@@ -45,4 +46,5 @@ __all__ = [
     "safety",
     "ssort",
     "twine",
+    "yore",
 ]

duty-1.6.0/src/duty/tools/_yore.py

@@ -0,0 +1,54 @@
+"""Callable for [Yore](https://github.com/pawamoy/yore)."""
+
+from __future__ import annotations
+
+from duty.tools._base import Tool
+
+
+class yore(Tool):  # noqa: N801
+    """Call [Yore](https://github.com/pawamoy/yore)."""
+
+    cli_name = "yore"
+
+    @classmethod
+    def check(
+        cls,
+        *paths: str,
+        bump: str | None = None,
+        eol_within: str | None = None,
+        bol_within: str | None = None,
+    ) -> yore:
+        """Checks Yore comments against Python EOL dates or the provided next version of your project.
+
+        Parameters:
+            paths: Path to files or directories to check.
+            bump: The next version of your project.
+            eol_within: The time delta to start checking before the End of Life of a Python version.
+                It is provided in a human-readable format, like `2 weeks` or `1 month`.
+                Spaces are optional, and the unit can be shortened to a single letter:
+                `d` for days, `w` for weeks, `m` for months, and `y` for years.
+            bol_within: The time delta to start checking before the Beginning of Life of a Python version.
+                It is provided in a human-readable format, like `2 weeks` or `1 month`.
+                Spaces are optional, and the unit can be shortened to a single letter:
+                `d` for days, `w` for weeks, `m` for months, and `y` for years.
+        """
+        cli_args = ["check", *paths]
+
+        if bump:
+            cli_args.append("--bump")
+            cli_args.append(bump)
+
+        if eol_within:
+            cli_args.append("--eol-within")
+            cli_args.append(eol_within)
+
+        if bol_within:
+            cli_args.append("--bol-within")
+            cli_args.append(bol_within)
+
+        return cls(cli_args)
+
+    def __call__(self) -> int:
+        from yore import main as run_yore
+
+        return run_yore(self.cli_args)