feu 0.3.2__tar.gz → 0.3.3__tar.gz

{feu-0.3.2 → feu-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: feu
-Version: 0.3.2
+Version: 0.3.3
 Summary: A light library to help to manage packages
 License: BSD-3-Clause
 Keywords: package,install,dependency
@@ -23,8 +23,10 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
 Provides-Extra: all
 Provides-Extra: cli
+Provides-Extra: git
 Requires-Dist: click (>=8.1,<9.0) ; extra == "all" or extra == "cli"
-Requires-Dist: packaging (>=21.0,<25.0)
+Requires-Dist: gitpython (>=3.1.41,<4.0) ; extra == "git"
+Requires-Dist: packaging (>=21.0,<26.0)
 Project-URL: Homepage, https://github.com/durandtibo/feu
 Project-URL: Repository, https://github.com/durandtibo/feu
 Description-Content-Type: text/markdown
@@ -123,17 +125,18 @@ Please check the [get started page](https://durandtibo.github.io/feu/get_started
 install only some specific dependencies or other alternatives to install the library.
 The following is the corresponding `feu` versions and supported dependencies.
 
-| `feu`   | `packaging`    | `python`      | `click`<sup>*</sup> |
-|---------|----------------|---------------|---------------------|
-| `main`  | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |
-| `0.3.2` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |
-| `0.3.1` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |
-| `0.3.0` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |
-| `0.2.4` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
-| `0.2.3` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
-| `0.2.2` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
-| `0.2.1` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
-| `0.2.0` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
+| `feu`   | `packaging`    | `python`      | `click`<sup>*</sup> | `gitpython`<sup>*</sup> |
+|---------|----------------|---------------|---------------------|-------------------------|
+| `main`  | `>=21.0,<26.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        | `>=3.1.41,<4.0`         |
+| `0.3.3` | `>=21.0,<26.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        | `>=3.1.41,<4.0`         |
+| `0.3.2` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |                         |
+| `0.3.1` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |                         |
+| `0.3.0` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |                         |
+| `0.2.4` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
+| `0.2.3` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
+| `0.2.2` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
+| `0.2.1` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
+| `0.2.0` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
 
 <sup>*</sup> indicates an optional dependency
 

{feu-0.3.2 → feu-0.3.3}/README.md

@@ -92,17 +92,18 @@ Please check the [get started page](https://durandtibo.github.io/feu/get_started
 install only some specific dependencies or other alternatives to install the library.
 The following is the corresponding `feu` versions and supported dependencies.
 
-| `feu`   | `packaging`    | `python`      | `click`<sup>*</sup> |
-|---------|----------------|---------------|---------------------|
-| `main`  | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |
-| `0.3.2` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |
-| `0.3.1` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |
-| `0.3.0` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |
-| `0.2.4` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
-| `0.2.3` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
-| `0.2.2` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
-| `0.2.1` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
-| `0.2.0` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |
+| `feu`   | `packaging`    | `python`      | `click`<sup>*</sup> | `gitpython`<sup>*</sup> |
+|---------|----------------|---------------|---------------------|-------------------------|
+| `main`  | `>=21.0,<26.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        | `>=3.1.41,<4.0`         |
+| `0.3.3` | `>=21.0,<26.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        | `>=3.1.41,<4.0`         |
+| `0.3.2` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |                         |
+| `0.3.1` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |                         |
+| `0.3.0` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0`        |                         |
+| `0.2.4` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
+| `0.2.3` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
+| `0.2.2` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
+| `0.2.1` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
+| `0.2.0` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0`        |                         |
 
 <sup>*</sup> indicates an optional dependency
 

{feu-0.3.2 → feu-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "feu"
-version = "0.3.2"
+version = "0.3.3"
 description = "A light library to help to manage packages"
 readme = "README.md"
 authors = ["Thibaut Durand <durand.tibo+gh@gmail.com>"]
@@ -32,14 +32,16 @@ packages = [
 [tool.poetry.dependencies]
 # Core dependencies
 python = ">=3.9,<3.14"
-packaging = ">=21.0,<25.0"
+packaging = ">=21.0,<26.0"
 
 # Optional dependencies
 click = { version = ">=8.1,<9.0", optional = true }
+gitpython = { version = ">=3.1.41,<4.0", optional = true }
 
 [tool.poetry.extras]
-all = ["click"]
+all = ["click", "git"]
 cli = ["click"]
+git = ["gitpython"]
 
 [tool.poetry.group.docs]
 optional = true
@@ -47,18 +49,18 @@ optional = true
 [tool.poetry.group.docs.dependencies]
 mike = "^2.1"
 mkdocs-material = "^9.5"
-mkdocstrings = { extras = ["python"], version = ">=0.26,<1.0" }
+mkdocstrings = { extras = ["python"], version = ">=0.29,<1.0" }
 
 [tool.poetry.group.dev.dependencies]
 black = ">=25.1"
-coverage = { extras = ["toml"], version = "^7.6" }
+coverage = { extras = ["toml"], version = "^7.8" }
 docformatter = { extras = ["tomli"], version = "^1.7" }
-pre-commit = "^4.1"
+pre-commit = "^4.2"
 pygments = "^2.19"
 pytest = "^8.3"
-pytest-cov = ">=5,<7"
+pytest-cov = ">=6,<7"
 pytest-timeout = "^2.3"
-ruff = ">=0.9,<1.0"
+ruff = ">=0.11,<1.0"
 xdoctest = "^1.2"
 
 [build-system]
@@ -152,8 +154,6 @@ lint.select = [
 ]
 lint.ignore = [
     "A003", # Class attribute `{name}` is shadowing a python builtin
-    "ANN101", # Missing type annotation for `self` in method
-    "ANN102", # Missing type annotation for `cls` in classmethod
     "ANN401", # Dynamically typed expressions (typing.Any) are disallowed.
     "B905", # `zip()` without an explicit strict= parameter set. The `strict=` argument was added in Python 3.10
     "E501", # Line lengths are recommended to be no greater than 79 characters.

{feu-0.3.2 → feu-0.3.3}/src/feu/__main__.py

@@ -2,6 +2,8 @@ r"""Contain the main entry point."""
 
 from __future__ import annotations
 
+import sys
+
 from feu.imports import is_click_available
 from feu.install import install_package
 from feu.package import find_closest_version as find_closest_version_
@@ -30,7 +32,12 @@ def install(pkg_name: str, pkg_version: str) -> None:
 
     python -m feu install --pkg_name=numpy --pkg_version=2.0.2
     """
-    install_package(package=pkg_name, version=pkg_version)
+    version = find_closest_version_(
+        pkg_name=pkg_name,
+        pkg_version=pkg_version,
+        python_version=f"{sys.version_info[0]}.{sys.version_info[1]}",
+    )
+    install_package(package=pkg_name, version=version)
 
 
 @click.command()

feu-0.3.3/src/feu/git.py

@@ -0,0 +1,91 @@
+r"""Contain git utility functions."""
+
+from __future__ import annotations
+
+__all__ = ["get_last_tag_name", "get_last_version_tag_name", "get_tags"]
+
+from contextlib import suppress
+from unittest.mock import Mock
+
+from packaging.version import InvalidVersion, Version
+
+from feu.imports import check_git, is_git_available
+
+if is_git_available():
+    import git
+else:  # pragma: no cover
+    git = Mock()
+
+
+def get_tags() -> list[git.TagReference]:
+    r"""Get the list of git tags sorted by date/time for the current
+    repository.
+
+    Returns:
+        The list of git tags sorted by date/time.
+
+    Example usage:
+
+    ```pycon
+
+    >>> from feu.git import get_tags
+    >>> tags = get_tags()
+    >>> tags
+
+    ```
+    """
+    check_git()
+    repo = git.Repo(search_parent_directories=True)
+    return sorted(repo.tags, key=lambda t: t.commit.committed_datetime)
+
+
+def get_last_tag_name() -> str:
+    r"""Get the name of the most recent tag in the current repository.
+
+    Returns:
+        The tag name.
+
+    Example usage:
+
+    ```pycon
+
+    >>> from feu.git import get_last_tag_name
+    >>> tag = get_last_tag_name()
+    >>> tag
+
+    ```
+    """
+    tags = get_tags()
+    if not tags:
+        msg = "No tag was found"
+        raise RuntimeError(msg)
+    return tags[-1].name
+
+
+def get_last_version_tag_name() -> str:
+    r"""Get the name of the most recent version tag in the current
+    repository.
+
+    A version tag is a tag starting with ``v{number}*``.
+
+    Returns:
+        The tag name.
+
+    Example usage:
+
+    ```pycon
+
+    >>> from feu.git import get_last_version_tag_name
+    >>> tag = get_last_version_tag_name()
+    >>> tag
+
+    ```
+    """
+    tags = get_tags()
+    for tag in tags[::-1]:
+        with suppress(InvalidVersion):
+            Version(tag.name)
+            return tag.name
+
+    msg = "No tag was found"
+    raise RuntimeError(msg)

{feu-0.3.2 → feu-0.3.3}/src/feu/imports.py

@@ -2,7 +2,14 @@ r"""Contain to check if a package or module is available."""
 
 from __future__ import annotations
 
-__all__ = ["check_click", "is_click_available", "is_module_available", "is_package_available"]
+__all__ = [
+    "check_click",
+    "check_git",
+    "is_click_available",
+    "is_git_available",
+    "is_module_available",
+    "is_package_available",
+]
 
 from contextlib import suppress
 from functools import lru_cache
@@ -15,7 +22,7 @@ def is_package_available(package: str) -> bool:
     """Check if a package is available.
 
     Args:
-        package: Specifies the package name to check.
+        package: The package name to check.
 
     Returns:
         ``True`` if the package is available, otherwise ``False``.
@@ -44,7 +51,7 @@ def is_module_available(module: str) -> bool:
     """Check if a module path is available.
 
     Args:
-        module: Specifies the module to check.
+        module: The module to check.
 
     Example usage:
 
@@ -115,3 +122,51 @@ def check_click() -> None:
             "pip install click\n"
         )
         raise RuntimeError(msg)
+
+
+###############
+#     git     #
+###############
+
+
+@lru_cache
+def is_git_available() -> bool:
+    r"""Indicate if the ``git`` package is installed or not.
+
+    Returns:
+        ``True`` if ``git`` is available otherwise ``False``.
+
+    Example usage:
+
+    ```pycon
+
+    >>> from feu.imports import is_git_available
+    >>> is_git_available()
+
+    ```
+    """
+    return is_package_available("git")
+
+
+def check_git() -> None:
+    r"""Check if the ``git`` package is installed.
+
+    Raises:
+        RuntimeError: if the ``git`` package is not installed.
+
+    Example usage:
+
+    ```pycon
+
+    >>> from feu.imports import check_git
+    >>> check_git()
+
+    ```
+    """
+    if not is_git_available():
+        msg = (
+            "'git' package is required but not installed. "
+            "You can install 'git' package with the command:\n\n"
+            "pip install gitpython\n"
+        )
+        raise RuntimeError(msg)

{feu-0.3.2 → feu-0.3.3}/src/feu/package.py

@@ -58,6 +58,7 @@ class PackageConfig:
         },
         # https://github.com/scikit-learn/scikit-learn/releases
         "scikit-learn": {
+            "3.13": {"min": "1.6.0", "max": None},
             "3.12": {"min": "1.3.1", "max": None},
             "3.11": {"min": "1.2.0", "max": None},
             "3.10": {"min": "1.1.0", "max": None},

{feu-0.3.2 → feu-0.3.3}/src/feu/testing.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 __all__ = [
     "click_available",
+    "git_available",
     "jax_available",
     "numpy_available",
     "pandas_available",
@@ -18,9 +19,10 @@ __all__ = [
 
 import pytest
 
-from feu.imports import is_click_available, is_package_available
+from feu.imports import is_click_available, is_git_available, is_package_available
 
 click_available = pytest.mark.skipif(not is_click_available(), reason="Requires click")
+git_available = pytest.mark.skipif(not is_git_available(), reason="Requires git")
 jax_available = pytest.mark.skipif(not is_package_available("jax"), reason="Requires JAX")
 numpy_available = pytest.mark.skipif(not is_package_available("numpy"), reason="Requires NumPy")
 pandas_available = pytest.mark.skipif(not is_package_available("pandas"), reason="Requires pandas")