poetry-plugin-hook 0.0.0__py3-none-any.whl → 1.4.0__py3-none-any.whl

poetry_plugin_hook/__init__.py

@@ -1,17 +1,33 @@
-from poetry.plugins.application_plugin import ApplicationPlugin
-
-from .latest import LatestCommand
-from .sync import SyncCommand
-
-
-class HookPlugin(ApplicationPlugin):
-    def activate(self, application):
-
-        application.command_loader.register_factory(
-            LatestCommand.name,
-            lambda: LatestCommand(),
-        )
-        application.command_loader.register_factory(
-            SyncCommand.name,
-            lambda: SyncCommand(),
-        )
+"""
+.. include:: ../README.md
+"""
+
+from poetry.plugins.application_plugin import ApplicationPlugin
+
+from poetry_plugin_hook.bump import BumpCommand
+from poetry_plugin_hook.latest import LatestCommand
+from poetry_plugin_hook.sync import SyncCommand
+
+
+class HookPlugin(ApplicationPlugin):
+    def activate(self, application):
+
+        application.command_loader.register_factory(
+            BumpCommand.name,
+            lambda: BumpCommand(),
+        )
+        application.command_loader.register_factory(
+            LatestCommand.name,
+            lambda: LatestCommand(),
+        )
+        application.command_loader.register_factory(
+            SyncCommand.name,
+            lambda: SyncCommand(),
+        )
+
+
+__all__ = [
+    "BumpCommand",
+    "LatestCommand",
+    "SyncCommand",
+]

poetry_plugin_hook/bump.py

@@ -0,0 +1,157 @@
+import os
+import re
+from pathlib import Path
+from typing import Any
+
+from cleo.helpers import option
+from poetry.console.commands.version import VersionCommand
+
+
+class PathNotFoundError(FileNotFoundError):
+    def __init__(self, path: os.PathLike):
+        errno = 2
+        super().__init__(
+            errno,
+            os.strerror(errno),
+            str(path),
+        )
+
+
+class BumpCommand(VersionCommand):
+    name = "hook bump"
+    description = "Update the version in pyproject.toml and synchronize it into files."
+    help = """\
+Update the version from package and also bumps __version__ strings in any given file.
+
+    <info>poetry hook bump --next-phase patch --file __init__.py</>
+
+The new version should ideally be a valid semver string or a valid bump rule:
+patch, minor, major, prepatch, preminor, premajor, prerelease.
+
+If no next-phase or version is provied the version from the pyproject.toml file will be
+synced into the files.
+"""
+
+    _regex = re.compile(
+        r"(?P<prefix>__version__\s*=\s*)(?P<quote>['\"])(?P<version>[^'\"]+)(?P=quote)",
+        re.IGNORECASE,
+    )
+
+    _del_options = ["short"]
+
+    @property
+    def root_dir(self) -> Path:
+        """
+        Parent of the pyproject.toml file.
+        """
+        return self.poetry.pyproject_path.parent
+
+    @property
+    def package(self) -> Path:
+        """
+        Path to the package directory.
+        """
+        return self.root_dir / self.poetry.package.name.replace("-", "_")
+
+    @property
+    def version(self) -> str:
+        """
+        Package version from the pyproject.toml file.
+        """
+
+        content: dict[str, Any] = self.poetry.file.read()
+        poetry_content = content["tool"]["poetry"]
+        return poetry_content["version"]
+
+    def substitute(self, file: Path, version: str) -> int:
+        """
+        Substitute the version in the file.
+        """
+
+        replacement = rf"\g<prefix>\g<quote>{version}\g<quote>"
+
+        content = file.read_text()
+
+        match = self._regex.search(content)
+
+        if not match:
+            self.line_error(
+                f"- Skipped: <warning>{file.relative_to(self.root_dir)}</warning>"
+            )
+            return 1
+
+        if not self.option("dry-run"):
+            file.write_text(
+                self._regex.sub(
+                    replacement,
+                    content,
+                    count=1,
+                ),
+            )
+
+        self.line(f"- Bumped : <info>{file.relative_to(self.root_dir)}</info>")
+
+        return 0
+
+    def resolve(self, filename: str) -> Path:
+        """
+        Resolve the file path to the package directory.
+        """
+
+        file = Path(filename)
+
+        try:
+            file = file.resolve(True)
+        except FileNotFoundError:
+
+            try:
+                root = self.root_dir
+
+                file = root.joinpath(filename).resolve(True)
+            except FileNotFoundError:
+                package = self.package
+
+                file = package.joinpath(filename).resolve(True)
+
+        finally:
+            if not file.is_file():
+                raise PathNotFoundError(file)
+
+        return file
+
+    def configure(self) -> None:
+        """
+        Modifiy all options from `poetry version` to fit the `poetry hook bump`
+        command.
+        """
+        self.options = [
+            option(
+                "file",
+                "f",
+                description="Specify the files to update the __version__ string.",
+                flag=False,
+                multiple=True,
+                default=["__init__.py"],
+            )
+        ] + [option for option in self.options if option.name not in self._del_options]
+
+        super().configure()
+
+    def handle(self) -> int:
+
+        result = super().handle()
+
+        if result:
+            return result
+
+        for file in self.option("file"):
+            try:
+                file = self.resolve(file)
+            except PathNotFoundError as e:
+                if self.io.is_verbose():
+                    self.line_error(f"- Error  : <error>{e.filename}</error>")
+                continue
+
+            result += self.substitute(file, self.version)
+
+        return 0

poetry_plugin_hook/latest.py

@@ -1,72 +1,133 @@
-import re
-
-from poetry.console.commands.show import ShowCommand
-
-from .redirect import buffered_io, strip_ansi
-
-
-class LatestCommand(ShowCommand):
-    name = "hook latest"
-    description = "Check if all top-level dependencies are up-to-date."
-    help = ""
-
-    _dependencies = re.compile(
-        r"^(?P<package>\w\S+)\s+"
-        r"(?P<current>\d\S+)\s+"
-        r"(?P<latest>\d\S+)\s+"
-        r"(?P<description>\w.*?)$",
-        re.MULTILINE,
-    )
-
-    _true_options = ["latest", "outdated", "top-level"]
-    _del_options = ["no-dev", "tree", "all", "why"]
-
-    def configure(self) -> None:
-        """
-        Modifiy all options from `poetry show` to fit the `poetry latest` command.
-
-        Returns:
-            None
-        """
-
-        self.options = [
-            option for option in self.options if option.name not in self._del_options
-        ]
-
-        for opt in filter(lambda o: o.name in self._true_options, self.options):
-            opt._description += " <warning>(option is always True)</warning>"
-
-        super().configure()
-
-    def handle(self) -> int:
-        """
-        Executes `poetry show -o -T` to check for outdated dependencies.
-
-        Catches stdout to check for dependencies and returns non-zero.
-
-        Returns:
-            int: Non-zero if there are outdated dependencies, zero otherwise.
-        """
-
-        # force options to True, `poetry show -o -T`
-        for option in self._true_options:
-            self.io.input.set_option(option, True)
-
-        # redirect output to check for outdated dependencies
-        with buffered_io(self) as io:
-            super().handle()
-            text = io.fetch_output()
-
-        # count outdated dependencies
-        outdated = len(
-            self._dependencies.findall(
-                strip_ansi(text),
-            )
-        )
-
-        if outdated == 0:
-            self.line("All top-level dependencies are up-to-date.")
-        else:
-            self.line(text)
-
-        return outdated
+import re
+
+from poetry.console.commands.show import ShowCommand
+
+from poetry_plugin_hook.redirect import buffered_io, strip_ansi
+
+
+class LatestCommand(ShowCommand):
+    name = "hook latest"
+    description = "Check if all top-level dependencies are up-to-date."
+    help = """\
+To check if all top-level dependencies of your package are up-to-date
+    <info>poetry hook latest --only=main</>
+
+If a specific package is outdated
+    <info>poetry hook latest <package></>
+"""
+
+    _version = (
+        r"([1-9][0-9]*!)?"
+        r"(0|[1-9][0-9]*)"
+        r"(\.(0|[1-9][0-9]*))*"
+        r"((a|b|rc)(0|[1-9][0-9]*))?"
+        r"(\.post(0|[1-9][0-9]*))?"
+        r"(\.dev(0|[1-9][0-9]*))?"
+    )
+    """PEP 440 version regex."""
+
+    _dependencies = re.compile(
+        r"^(?P<package>.*?)\s+"
+        rf"(?P<current>{_version})\s+"
+        rf"(?P<latest>{_version})\s+"
+        r"(?P<description>.*?)$",
+        re.MULTILINE,
+    )
+
+    _true_options = ["latest", "outdated", "top-level"]
+    _del_options = ["no-dev", "tree", "all", "why"]
+
+    def configure(self) -> None:
+        """
+        Modifiy all options from `poetry show -o -T` to fit the `poetry hook latest`
+        command.
+        """
+
+        self.options = [
+            option for option in self.options if option.name not in self._del_options
+        ]
+
+        for opt in filter(lambda o: o.name in self._true_options, self.options):
+            opt._description += " <warning>(option is always True)</warning>"
+
+        super().configure()
+
+    def handle(self) -> int:
+        """
+        Executes `poetry show -o -T` to check for outdated dependencies.
+
+        Returns:
+            int: Non-zero if there are outdated dependencies, zero otherwise.
+        """
+
+        # force options to True, `poetry show -o -T`
+        for option in self._true_options:
+            self.io.input.set_option(option, True)
+
+        # check for certain package if specified
+        package = self.io.input.argument("package")
+        if package:
+            self.io.input.set_argument("package", None)
+
+        # redirect output to check for outdated dependencies
+        with buffered_io(self) as io:
+            super().handle()
+            stdout = io.fetch_output()
+            stderr = io.fetch_error()
+
+        if stdout.strip() or stderr.strip():
+            self.line(stdout)
+            self.line_error(stderr)
+
+        stdout = strip_ansi(stdout)
+
+        if package is not None:
+            return self._handle_package(package, stdout)
+
+        return self._handle_outdated(stdout)
+
+    def _handle_outdated(self, stdout: str) -> int:
+        """
+        Handles the output of the `poetry show -o -T` command to check for outdated
+        dependencies.
+
+        Prints a message if all top-level dependencies are up-to-date.
+
+        Args:
+            stdout (str): The standard output from the `poetry show -o -T` command.
+
+        Returns:
+            int: The number of outdated dependencies.
+        """
+        outdated = len(self._dependencies.findall(stdout))
+
+        if outdated == 0:
+            self.line("All top-level dependencies are up-to-date.", style="info")
+
+        return outdated
+
+    def _handle_package(self, package: str, stdout: str) -> int:
+        """
+        Handles the output of the `poetry show -o -T` command to check for the given
+        package.
+
+        Prints a message if the top-level package is not found in the output.
+
+        Args:
+            package (str): The name of the package to check.
+            stdout (str): The standard output from the `poetry show -o -T` command.
+        Returns:
+            int: Returns 1 if the package is outdated otherwise returns 0.
+        """
+
+        _dependency = re.compile(
+            re.escape(package),
+        )
+
+        for match in self._dependencies.finditer(stdout):
+            _package = match.group("package").split()[0]
+            if _dependency.fullmatch(_package):
+                return 1
+
+        self.line(f"Top-level {package=} is up-to-date.", style="info")
+        return 0

poetry_plugin_hook/redirect.py

@@ -1,82 +1,82 @@
-import contextlib
-import re
-from abc import ABC, abstractmethod
-from typing import Generator, List
-
-from cleo.io.buffered_io import BufferedIO
-from cleo.io.io import IO
-
-
-class CommandCleo(ABC):
-    @property
-    @abstractmethod
-    def _io(self) -> IO:
-        pass
-
-
-def strip_ansi(text: str) -> str:
-    """
-    Remove ANSI escape sequences from a string.
-
-    Args:
-        text (str): The string to remove ANSI escape sequences from.
-
-    Returns:
-        str: The string without ANSI escape sequences.
-    """
-    return re.sub(r"\x1B[@-_][0-?]*[ -/]*[@-~]", "", text)
-
-
-@contextlib.contextmanager
-def buffered_io(
-    *args: CommandCleo,
-    **kwargs,
-) -> Generator[BufferedIO, None, None]:
-    """
-    Context manager that temporarily replaces the I/O of multiple Poetry commands with
-    the same buffered I/O to capture their output.
-
-    Args:
-        *cmds (List[CommandCleo]): The Poetry commands whose I/O will be captured.
-        **kwargs: Additional keyword arguments to pass to the BufferedIO constructor.
-
-    Yields:
-        BufferedIO: The buffered I/O object.
-
-    Raises:
-        ValueError: If any of the commands does not have an I/O attribute.
-
-    Example:
-        ```python
-        with buffered_ios(cmd1, cmd2, decorated=False) as io:
-            # Perform operations with the buffered I/O
-            output = io.fetch_output()
-        ```
-    """
-
-    # perform check if all commands have a `_io` attribute
-    original: List[IO] = []
-
-    for cmd in args:
-        if not hasattr(cmd, "_io"):
-            raise ValueError(f"Command {cmd} does not have an I/O attribute.")
-
-        original.append(cmd._io)
-
-    # create a new buffered I/O object
-    io = BufferedIO(
-        input=kwargs.pop("input", original[0].input),
-        decorated=kwargs.pop("decorated", original[0].output.is_decorated()),
-        **kwargs,
-    )
-
-    try:
-        # assign the buffered I/O object to all commands
-        for cmd in args:
-            cmd._io = io
-
-        yield io
-    finally:
-        # restore the original I/O objects
-        for cmd, original_io in zip(args, original):
-            cmd._io = original_io
+import contextlib
+import re
+from abc import ABC, abstractmethod
+from typing import Generator, List
+
+from cleo.io.buffered_io import BufferedIO
+from cleo.io.io import IO
+
+
+class CommandCleo(ABC):  # pragma: no cover
+    @property
+    @abstractmethod
+    def _io(self) -> IO:
+        pass
+
+
+def strip_ansi(text: str) -> str:
+    """
+    Remove ANSI escape sequences from a string.
+
+    Args:
+        text (str): The string to remove ANSI escape sequences from.
+
+    Returns:
+        str: The string without ANSI escape sequences.
+    """
+    return re.sub(r"\x1B[@-_][0-?]*[ -/]*[@-~]", "", text)
+
+
+@contextlib.contextmanager
+def buffered_io(
+    *args: CommandCleo,
+    **kwargs,
+) -> Generator[BufferedIO, None, None]:
+    """
+    Context manager that temporarily replaces the I/O of multiple Poetry commands with
+    the same buffered I/O to capture their output.
+
+    Args:
+        *cmds (List[CommandCleo]): The Poetry commands whose I/O will be captured.
+        **kwargs: Additional keyword arguments to pass to the BufferedIO constructor.
+
+    Yields:
+        BufferedIO: The buffered I/O object.
+
+    Raises:
+        ValueError: If any of the commands does not have an I/O attribute.
+
+    Example:
+        ```python
+        with buffered_ios(cmd1, cmd2, decorated=False) as io:
+            # Perform operations with the buffered I/O
+            output = io.fetch_output()
+        ```
+    """
+
+    # perform check if all commands have a `_io` attribute
+    original: List[IO] = []
+
+    for cmd in args:
+        if not hasattr(cmd, "_io"):
+            raise ValueError(f"Command {cmd} does not have an I/O attribute.")
+
+        original.append(cmd._io)
+
+    # create a new buffered I/O object
+    io = BufferedIO(
+        input=kwargs.pop("input", original[0].input),
+        decorated=kwargs.pop("decorated", original[0].output.is_decorated()),
+        **kwargs,
+    )
+
+    try:
+        # assign the buffered I/O object to all commands
+        for cmd in args:
+            cmd._io = io
+
+        yield io
+    finally:
+        # restore the original I/O objects
+        for cmd, original_io in zip(args, original):
+            cmd._io = original_io

poetry_plugin_hook/sync.py

@@ -1,90 +1,106 @@
-import re
-
-from cleo.exceptions import CleoError
-from cleo.helpers import option
-from poetry.console.commands.install import InstallCommand
-
-from .redirect import buffered_io, strip_ansi
-
-
-class SyncCommand(InstallCommand):
-    name = "hook sync"
-    description = "Install the current project and synchronize the environment."
-    help = ""
-
-    _true_options = ["sync"]
-    _del_options = ["no-dev", "remove-untracked", "compile"]
-    _exit_codes = ["any", "installs", "updates", "removals"]
-
-    _operations = re.compile(
-        r"^Package operations: "
-        r"(?P<installs>\d+)\D+"
-        r"(?P<updates>\d+)\D+"
-        r"(?P<removals>\d+)\D+"
-        r"(?P<skipped>\d+)\D+$",
-        re.MULTILINE,
-    )
-
-    def configure(self) -> None:
-
-        self.options = [
-            option(
-                "exit",
-                description=(
-                    "Specify the value to return as exitcode. "
-                    f"<info>choices={str(self._exit_codes)}</info>"
-                ),
-                flag=False,
-                default="any",
-            )
-        ] + [option for option in self.options if option.name not in self._del_options]
-
-        for opt in filter(lambda o: o.name in self._true_options, self.options):
-            opt._description += " <warning>(option is always True)</warning>"
-
-        super().configure()
-
-    def handle(self) -> int:
-
-        # check if the exit option is valid
-        exit = self.io.input.option("exit")
-        if exit not in self._exit_codes:
-            raise CleoError(f"Invalid option: {exit=}")
-
-        # force options to `poetry install --sync`
-        for opt in self._true_options:
-            self.io.input.set_option(opt, True)
-
-        with buffered_io(
-            self.installer.executor,
-            self.installer,
-            self,
-        ) as io:
-            super().handle()
-            stdout = io.fetch_output()
-
-        # parse the output for matching lines and take the last one
-        match: re.Match = list(
-            self._operations.finditer(
-                strip_ansi(stdout),
-            )
-        )[-1]
-
-        # retrive the exit code
-        try:
-            result = int(match.group(exit))
-        except IndexError:
-            result = 0
-
-            for code in self._exit_codes:
-                try:
-                    result += int(match.group(code))
-                except IndexError:
-                    pass
-
-        if result == 0:
-            self.line(match.group(0))
-        else:
-            self.line(stdout)
-
-        return result
+import re
+
+from cleo.exceptions import CleoLogicError
+from cleo.helpers import option
+from poetry.console.commands.install import InstallCommand
+
+from poetry_plugin_hook.redirect import buffered_io, strip_ansi
+
+
+class SyncCommand(InstallCommand):
+    name = "hook sync"
+    description = (
+        "Synchronize the environment with the locked packages and the specified groups."
+    )
+    help = """\
+To check if your environment is synchronized without making any changes
+    <info>poetry hook sync --dry-run</>
+"""
+
+    _true_options = ["sync"]
+    _del_options = ["no-dev", "remove-untracked", "compile"]
+    _exit_codes = ["any", "installs", "updates", "removals"]
+
+    _operations = re.compile(
+        r"^Package operations: "
+        r"(?P<installs>\d+)\D+"
+        r"(?P<updates>\d+)\D+"
+        r"(?P<removals>\d+)\D+"
+        r"(?:(?P<skipped>\d+)\D+)?$",
+        re.MULTILINE,
+    )
+
+    def configure(self) -> None:
+        """
+        Modifiy all options from `poetry install --sync` to fit the `poetry hook sync`
+        command.
+
+        The `--exit` option is added to specify the return value of the command.
+        """
+
+        self.options = [
+            option(
+                "exit",
+                description=(
+                    "Specify the value to return as exitcode. "
+                    f"<info>choices={str(self._exit_codes)}</info>"
+                ),
+                flag=False,
+                default="any",
+            )
+        ] + [option for option in self.options if option.name not in self._del_options]
+
+        for opt in filter(lambda o: o.name in self._true_options, self.options):
+            opt._description += " <warning>(option is always True)</warning>"
+
+        super().configure()
+
+    def handle(self) -> int:
+        """
+        Executes `poetry install --sync` to synchronize the environment with the locked
+        packages and the specified groups.
+
+        Returns:
+            int: Non-zero exit code specified by the `--exit` option.
+        """
+
+        # check if the exit option is valid
+        exit = self.io.input.option("exit")
+        if exit not in self._exit_codes:
+            raise CleoLogicError(f"Invalid option: {exit=}")
+
+        # force options to `poetry install --sync`
+        for opt in self._true_options:
+            self.io.input.set_option(opt, True)
+
+        with buffered_io(
+            self.installer.executor,
+            self.installer,
+            self,
+        ) as io:
+            super().handle()
+            stdout = io.fetch_output()
+            stderr = io.fetch_error()
+
+        match = self._operations.search(strip_ansi(stdout))
+
+        # retrieve the exit code
+        try:
+            result = int(match.group(exit))
+        except AttributeError:
+            self.line("No dependencies to syncronize.", style="info")
+            return 0
+        except IndexError:
+            result = 0
+
+            for code in self._exit_codes:
+                try:
+                    result += int(match.group(code))
+                except IndexError:
+                    pass
+
+        if stdout.strip() or stderr.strip():
+            self.line(stdout)
+            self.line_error(stderr)
+
+        return result

{poetry_plugin_hook-0.0.0.dist-info → poetry_plugin_hook-1.4.0.dist-info}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Christoph Dörrer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Christoph Dörrer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

poetry_plugin_hook-1.4.0.dist-info/METADATA

@@ -0,0 +1,287 @@
+Metadata-Version: 2.3
+Name: poetry-plugin-hook
+Version: 1.4.0
+Summary: poetry plugin to register wrapped commands to use as pre-commit-hooks
+License: MIT
+Keywords: poetry,pre-commit,plugin,hook
+Author: Christoph Dörrer
+Author-email: d-chris@web.de
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: cleo (>=2.1.0,<3.0.0)
+Requires-Dist: poetry (>=1.7.0)
+Project-URL: documentation, https://d-chris.github.io/poetry-plugin-hook
+Project-URL: repository, https://github.com/d-chris/poetry-plugin-hook
+Description-Content-Type: text/markdown
+
+# poetry-plugin-hook
+
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/poetry-plugin-hook)](https://pypi.org/project/poetry-plugin-hook/)
+[![PyPI - Version](https://img.shields.io/pypi/v/poetry-plugin-hook)](https://pypi.org/project/poetry-plugin-hook/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/poetry-plugin-hook)](https://pypi.org/project/poetry-plugin-hook/)
+[![PyPI - License](https://img.shields.io/pypi/l/poetry-plugin-hook)](https://raw.githubusercontent.com/d-chris/poetry-plugin-hook/main/LICENSE)
+[![GitHub - Pytest](https://img.shields.io/github/actions/workflow/status/d-chris/poetry-plugin-hook/pytest.yml?logo=github&label=pytest)](https://github.com/d-chris/poetry-plugin-hook/actions/workflows/pytest.yml)
+[![GitHub - Page](https://img.shields.io/website?url=https%3A%2F%2Fd-chris.github.io%2Fpoetry-plugin-hook&up_message=pdoc&logo=github&label=documentation)](https://d-chris.github.io/poetry-plugin-hook)
+[![GitHub - Release](https://img.shields.io/github/v/tag/d-chris/poetry-plugin-hook?logo=github&label=github)](https://github.com/d-chris/poetry-plugin-hook)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://raw.githubusercontent.com/d-chris/poetry-plugin-hook/main/.pre-commit-config.yaml)
+[![codecov](https://codecov.io/gh/d-chris/poetry-plugin-hook/graph/badge.svg?token=RNNV7TN8WZ)](https://codecov.io/gh/d-chris/poetry-plugin-hook)
+
+---
+
+[`poetry`](https://python-poetry.org/) plugin to register wrapped commands to use as [`pre-commit-hooks`](https://pre-commit.com/). all hook commands return zero on success and non-zero on failure.
+
+## install
+
+```cmd
+$ pip install poetry-plugin-hook
+```
+
+or with `poetry`
+
+> Especially on [Windows](https://python-poetry.org/docs/cli/#self), self commands that update or remove packages may be problematic.
+
+```cmd
+$ poetry self add poetry-plugin-hook
+```
+
+## hook bump
+
+Extends `poetry version` command, to also bump `__version__` strings in python files.
+
+```cmd
+$ poetry hook bump --help
+
+  Description:
+    Update the version in pyproject.toml and synchronize it into files.
+
+  Usage:
+    hook bump [options] [--] [<version>]
+
+  Arguments:
+    version                    The version number or the rule to update the version.
+
+  Options:
+    -f, --file=FILE            Specify the files to update the __version__ string. [default: ["__init__.py"]] (multiple values allowed)
+        --dry-run              Do not update pyproject.toml file
+        --next-phase           Increment the phase of the current version
+    -h, --help                 Display help for the given command. When no command is given display help for the list command.
+    -q, --quiet                Do not output any message.
+    -V, --version              Display this application version.
+        --ansi                 Force ANSI output.
+        --no-ansi              Disable ANSI output.
+    -n, --no-interaction       Do not ask any interactive question.
+        --no-plugins           Disables plugins.
+        --no-cache             Disables Poetry source caches.
+    -P, --project=PROJECT      Specify another path as the project root. All command-line arguments will be resolved relative to the current working directory.
+    -C, --directory=DIRECTORY  The working directory for the Poetry command (defaults to the current working directory). All command-line arguments will be resolved relative to the given directory.
+    -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
+
+  Help:
+    Update the version from package and also bumps __version__ strings in any given file.
+
+        poetry hook bump --next-phase patch --file __init__.py
+
+    The new version should ideally be a valid semver string or a valid bump rule:
+    patch, minor, major, prepatch, preminor, premajor, prerelease.
+
+    If no next-phase or version is provied the version from the pyproject.toml file will be
+    synced into the files.
+```
+
+## hook latest
+
+Wrapper for `poetry show -o -T` command.
+
+Exit code represents the number of outdated packages.
+
+```cmd
+$ poetry hook latest --help
+
+  Description:
+    Check if all top-level dependencies are up-to-date.
+
+  Usage:
+    hook latest [options] [--] [<package>]
+
+  Arguments:
+    package                    The package to inspect
+
+  Options:
+        --without=WITHOUT      The dependency groups to ignore. (multiple values allowed)
+        --with=WITH            The optional dependency groups to include. (multiple values allowed)
+        --only=ONLY            The only dependency groups to include. (multiple values allowed)
+    -l, --latest               Show the latest version. (option is always True)
+    -o, --outdated             Show the latest version but only for packages that are outdated. (option is always True)
+    -T, --top-level            Show only top-level dependencies. (option is always True)
+    -h, --help                 Display help for the given command. When no command is given display help for the list command.
+    -q, --quiet                Do not output any message.
+    -V, --version              Display this application version.
+        --ansi                 Force ANSI output.
+        --no-ansi              Disable ANSI output.
+    -n, --no-interaction       Do not ask any interactive question.
+        --no-plugins           Disables plugins.
+        --no-cache             Disables Poetry source caches.
+    -P, --project=PROJECT      Specify another path as the project root. All command-line arguments will be resolved relative to the current working directory.
+    -C, --directory=DIRECTORY  The working directory for the Poetry command (defaults to the current working directory). All command-line arguments will be resolved relative to the given directory.
+    -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
+
+  Help:
+    To check if all top-level dependencies of your package are up-to-date
+        poetry hook latest --only=main
+
+    If a specific package is outdated
+        poetry hook latest <package>
+```
+
+## hook sync
+
+Wrapper for `poetry install --sync` command.
+
+With `--exit` option, the command returns the corresponding value as exit code. With it's default `--exit=any` the sum of *installs*, *updates* and *removals* is returned.
+
+```cmd
+$ poetry hook sync --help
+
+  Description:
+    Synchronize the environment with the locked packages and the specified groups.
+
+  Usage:
+    hook sync [options]
+
+  Options:
+        --exit=EXIT            Specify the value to return as exitcode. choices=['any', 'installs', 'updates', 'removals'] [default: "any"]
+        --without=WITHOUT      The dependency groups to ignore. (multiple values allowed)
+        --with=WITH            The optional dependency groups to include. (multiple values allowed)
+        --only=ONLY            The only dependency groups to include. (multiple values allowed)
+        --sync                 Synchronize the environment with the locked packages and the specified groups. (Deprecated) (option is always True)
+        --no-root              Do not install the root package (the current project).
+        --no-directory         Do not install any directory path dependencies; useful to install dependencies without source code, e.g. for caching of Docker layers)
+        --dry-run              Output the operations but do not execute anything (implicitly enables --verbose).
+    -E, --extras=EXTRAS        Extra sets of dependencies to install. (multiple values allowed)
+        --all-extras           Install all extra dependencies.
+        --all-groups           Install dependencies from all groups.
+        --only-root            Exclude all dependencies.
+    -h, --help                 Display help for the given command. When no command is given display help for the list command.
+    -q, --quiet                Do not output any message.
+    -V, --version              Display this application version.
+        --ansi                 Force ANSI output.
+        --no-ansi              Disable ANSI output.
+    -n, --no-interaction       Do not ask any interactive question.
+        --no-plugins           Disables plugins.
+        --no-cache             Disables Poetry source caches.
+    -P, --project=PROJECT      Specify another path as the project root. All command-line arguments will be resolved relative to the current working directory.
+    -C, --directory=DIRECTORY  The working directory for the Poetry command (defaults to the current working directory). All command-line arguments will be resolved relative to the given directory.
+    -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
+
+  Help:
+    To check if your environment is synchronized without making any changes
+        poetry hook sync --dry-run
+```
+
+## pre-commit-config
+
+Add the following to your `.pre-commit-config.yaml` file.
+
+```yaml
+default_install_hook_types:
+  - pre-commit
+  - pre-push
+default_stages:
+  - pre-commit
+repos:
+  - repo: https://github.com/d-chris/poetry-plugin-hook
+    rev: v1.2.1
+    hooks:
+      - id: poetry-hook-bump
+      - id: poetry-hook-latest
+        args: ["--only=main"]
+      - id: poetry-hook-sync
+        args: ["--dry-run"]
+```
+
+### usage
+
+1. Make sure pre-commit is installed, see [official documentation](https://pre-commit.com/#installation).
+  ```cmd
+  $ pre-commit --version
+
+    pre-commit 3.7.1
+  ```
+2. `cd` into your project and register hooks and install them. this may take a while.
+  ```cmd
+  $ pre-commit install --install-hooks
+
+    pre-commit installed at .git\hooks\pre-commit
+    pre-commit installed at .git\hooks\pre-push
+  ```
+3. Test the pre-push hook.
+  ```cmd
+  $ pre-commit run poetry-hook-latest --all-files --hook-stage pre-push
+
+    poetry-hook-latest.......................................................Failed
+    - hook id: poetry-hook-latest
+    - exit code: 1
+
+    pytest-cov 5.0.0 6.0.0 Pytest plugin for measuring coverage.
+  ```
+4. Test the pre-commit hooks.
+  ```cmd
+  $ pre-commit run poetry-hook-sync --all-files
+
+    poetry-hook-sync.........................................................Failed
+    - hook id: poetry-hook-sync
+    - exit code: 1
+
+    Installing dependencies from lock file
+
+    Package operations: 0 installs, 1 update, 0 removals
+
+      - Downgrading pytest-cov (6.0.0 -> 5.0.0)
+
+    Installing the current project: poetry-plugin-hook (0.0.0)
+  ```
+
+## pre-commit-hooks
+
+```yaml
+- id: poetry-hook-bump
+  name: poetry-hook-bump
+  description: Bump the version of the package and also in files.
+  entry: poetry hook bump
+  language: system
+  pass_filenames: false
+  always_run: true
+  stages: [pre-push]
+- id: poetry-hook-latest
+  name: poetry-hook-latest
+  description: Check if all top-level dependencies are up-to-date.
+  entry: poetry hook latest
+  language: system
+  pass_filenames: false
+  always_run: true
+  stages: [pre-push]
+- id: poetry-hook-sync
+  name: poetry-hook-sync
+  description: Synchronize the environment with the locked packages and the specified groups.
+  entry: poetry hook sync
+  language: system
+  pass_filenames: false
+  files: ^(.*/)?(poetry\.lock|pyproject\.toml)$
+```
+
+## Dependencies
+
+[![PyPI - cleo](https://img.shields.io/pypi/v/cleo?logo=pypi&logoColor=white&label=cleo)](https://pypi.org/project/cleo/)
+[![PyPI - poetry](https://img.shields.io/pypi/v/poetry?logo=poetry&logoColor=white&label=poetry)](https://pypi.org/project/poetry/)
+
+---
+

poetry_plugin_hook-1.4.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+poetry_plugin_hook/__init__.py,sha256=6QewfFFP69aVHMK3v1FyCNJLA3YMkMkz9RfJ1RYsDXI,788
+poetry_plugin_hook/bump.py,sha256=AH2aNa2eJHXtzjt3r8jGZfEDJ_csUw5-Kgcm1LAAnuc,4176
+poetry_plugin_hook/latest.py,sha256=gybKBpqVRzA5z9Xjn4u4okML-Ddn0MrZ76EKBd78t-k,4046
+poetry_plugin_hook/redirect.py,sha256=uDe-xlXKmyJqBGw9HEFy_HhAPr37HDAAIMMQyjd2Ibg,2153
+poetry_plugin_hook/sync.py,sha256=kY7Ac_-UbI2_iFHZQUJDSNW3vPfM8kEPM5F7yh9IhKs,3211
+poetry_plugin_hook-1.4.0.dist-info/LICENSE,sha256=Ht_pJ-L8m2lTUYYUJK3BKAef0sGTcaITzbPtGy4qZxk,1074
+poetry_plugin_hook-1.4.0.dist-info/METADATA,sha256=xehytre7EvfpW6KjETpby7X5E8h5-VPThCbrT3P2ah4,12634
+poetry_plugin_hook-1.4.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+poetry_plugin_hook-1.4.0.dist-info/entry_points.txt,sha256=kl0zCMvjQc4wRSKYgkhJYdTacDKVxgBuc27bBMwlqdc,64
+poetry_plugin_hook-1.4.0.dist-info/RECORD,,

{poetry_plugin_hook-0.0.0.dist-info → poetry_plugin_hook-1.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.8.1
+Generator: poetry-core 2.0.1
 Root-Is-Purelib: true
 Tag: py3-none-any

poetry_plugin_hook-0.0.0.dist-info/METADATA

@@ -1,55 +0,0 @@
-Metadata-Version: 2.1
-Name: poetry-plugin-hook
-Version: 0.0.0
-Summary: poetry plugin to register new command to check if all dependencies are up-to-date
-Author: Christoph Dörrer
-Author-email: d-chris@web.de
-Requires-Python: >=3.9,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: cleo (>=2.1.0,<3.0.0)
-Requires-Dist: poetry (>=1.8.0,<2.0.0)
-Description-Content-Type: text/markdown
-
-# poetry-plugin-latest
-
-poetry plugin to add a command to check if all dependencies are up-to-date
-
-```cmd
-$ poetry latest --help
-
-Description:
-  Check if all top-level dependencies are up-to-date
-
-Usage:
-  latest [options] [--] [<package>]
-
-Arguments:
-  package                    The package to inspect
-
-Options:
-      --without=WITHOUT      The dependency groups to ignore. (multiple values allowed)
-      --with=WITH            The optional dependency groups to include. (multiple values allowed)
-      --only=ONLY            The only dependency groups to include. (multiple values allowed)
-  -l, --latest               Show the latest version. (option is always True)
-  -o, --outdated             Show the latest version but only for packages that are outdated. (option is always True)
-  -T, --top-level            Show only top-level dependencies. (option is always True)
-  -h, --help                 Display help for the given command. When no command is given display help for the list command.
-  -q, --quiet                Do not output any message.
-  -V, --version              Display this application version.
-      --ansi                 Force ANSI output.
-      --no-ansi              Disable ANSI output.
-  -n, --no-interaction       Do not ask any interactive question.
-      --no-plugins           Disables plugins.
-      --no-cache             Disables Poetry source caches.
-  -C, --directory=DIRECTORY  The working directory for the Poetry command (defaults to the current working directory).
-  -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
-
-Help:
-  The show command displays detailed information about a package, or
-  lists all packages available.
-```
-

poetry_plugin_hook-0.0.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-poetry_plugin_hook/__init__.py,sha256=voDfXAXN5fseTNp3WoYqmws0RuXlbpwaWCI4BlFTtIg,483
-poetry_plugin_hook/latest.py,sha256=3Bq_Lp_VN7N47lcAd4eNRnT3yxuKokZpLQHAhvcD7Pg,2053
-poetry_plugin_hook/redirect.py,sha256=gauxL6c7Zy33hwvOqYCBng83ajdELJcRTWDpU2J4J5k,2215
-poetry_plugin_hook/sync.py,sha256=g22_JTJfWL9RM21h_jWncGnRa_KlDIIHyl_9PSV3ZW0,2640
-poetry_plugin_hook-0.0.0.dist-info/entry_points.txt,sha256=kl0zCMvjQc4wRSKYgkhJYdTacDKVxgBuc27bBMwlqdc,64
-poetry_plugin_hook-0.0.0.dist-info/LICENSE,sha256=r4et7kLDvZTYdQubvsPzH-Mq2FVYd6u4VsVBkiAuuf8,1095
-poetry_plugin_hook-0.0.0.dist-info/METADATA,sha256=ufgjCPaR32BqPae_8QwxWAssq5FgTxyzWrWIKna_ieg,2358
-poetry_plugin_hook-0.0.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-poetry_plugin_hook-0.0.0.dist-info/RECORD,,