Skip to content

Latest commit

 

History

History
"""CLI commands for README management."""

from __future__ import annotations

import typer

from usethis._config import usethis_config
from usethis._types.backend import BackendEnum
from usethis._ui.options import backend_opt, badges_opt, quiet_opt


def readme(
    quiet: bool = quiet_opt,
    backend: BackendEnum = backend_opt,
    badges: bool = badges_opt,
) -> None:
    """Create or update the README.md file, optionally adding badges."""
    from usethis._backend.uv.detect import is_uv_used
    from usethis._config_file import files_manager
    from usethis._console import err_print
    from usethis._core.badge import (
        add_badge,
        get_pre_commit_badge,
        get_ruff_badge,
        get_usethis_badge,
        get_uv_badge,
    )
    from usethis._core.readme import add_readme
    from usethis._tool.impl.base.pre_commit import PreCommitTool
    from usethis._tool.impl.base.ruff import RuffTool
    from usethis.errors import UsethisError

    with usethis_config.set(quiet=quiet, backend=backend), files_manager():
        try:
            add_readme()

            if badges:
                if RuffTool().is_used():
                    add_badge(get_ruff_badge())

                if PreCommitTool().is_used():
                    add_badge(get_pre_commit_badge())

                if is_uv_used():
                    add_badge(get_uv_badge())

                add_badge(get_usethis_badge())
        except UsethisError as err:
            err_print(err)
            raise typer.Exit(code=1) from None