dycw-actions 0.3.2__py3-none-any.whl → 0.6.4__py3-none-any.whl

actions/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.3.2"
+__version__ = "0.6.4"

actions/action_dicts/constants.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+GITHUB_TOKEN = "${{github.token}}"  # noqa: S105
+PRERELEASE = "disallow"
+RESOLUTION = "highest"
+
+
+__all__ = ["GITHUB_TOKEN", "PRERELEASE", "RESOLUTION"]

actions/action_dicts/lib.py

@@ -0,0 +1,186 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+import actions.publish_package.doc
+import actions.random_sleep.doc
+import actions.run_hooks.doc
+import actions.tag_commit.doc
+from actions.action_dicts.constants import GITHUB_TOKEN, PRERELEASE, RESOLUTION
+
+if TYPE_CHECKING:
+    from actions.types import StrDict
+
+
+def run_action_pre_commit_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    submodules: str | None = None,
+    repos: Any | None = None,
+    hooks: Any | None = None,
+    sleep: int = 1,
+    gitea: bool = False,
+) -> StrDict:
+    dict_: StrDict = {"token": token}
+    _add_item(dict_, "submodules", value=submodules)
+    _add_item(dict_, "repos", value=repos)
+    _add_item(dict_, "hooks", value=hooks)
+    dict_["sleep"] = sleep
+    return {
+        "if": f"{_runner(gitea=gitea)}.event_name == 'pull_request'",
+        "name": actions.run_hooks.doc.DOCSTRING,
+        "uses": "dycw/action-run-hooks@latest",
+        "with": dict_,
+    }
+
+
+def run_action_publish_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    username: str | None = None,
+    password: str | None = None,
+    publish_url: str | None = None,
+    trusted_publishing: bool = False,
+    native_tls: bool = False,
+) -> StrDict:
+    dict_: StrDict = {"token": token}
+    _add_item(dict_, "username", value=username)
+    _add_item(dict_, "password", value=password)
+    _add_item(dict_, "publish-url", value=publish_url)
+    _add_boolean(dict_, "trusted-publishing", value=trusted_publishing)
+    _add_native_tls(dict_, native_tls=native_tls)
+    return {
+        "name": actions.publish_package.doc.DOCSTRING,
+        "uses": "dycw/action-publish-package@latest",
+        "with": dict_,
+    }
+
+
+def run_action_pyright_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    python_version: str | None = None,
+    resolution: str = RESOLUTION,
+    prerelease: str = PRERELEASE,
+    native_tls: bool = False,
+    with_requirements: str | None = None,
+) -> StrDict:
+    dict_: StrDict = {"token": token}
+    _add_python_version(dict_, python_version=python_version)
+    dict_["resolution"] = resolution
+    dict_["prerelease"] = prerelease
+    _add_native_tls(dict_, native_tls=native_tls)
+    _add_with_requirements(dict_, with_requirements=with_requirements)
+    return {
+        "name": "Run 'pyright'",
+        "uses": "dycw/action-pyright@latest",
+        "with": dict_,
+    }
+
+
+def run_action_pytest_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    python_version: str | None = None,
+    sops_age_key: str | None = None,
+    resolution: str = RESOLUTION,
+    prerelease: str = PRERELEASE,
+    native_tls: bool = False,
+    with_requirements: str | None = None,
+) -> StrDict:
+    dict_: StrDict = {"token": token}
+    _add_python_version(dict_, python_version=python_version)
+    _add_item(dict_, "sops-age-key", value=sops_age_key)
+    dict_["resolution"] = resolution
+    dict_["prerelease"] = prerelease
+    _add_native_tls(dict_, native_tls=native_tls)
+    _add_with_requirements(dict_, with_requirements=with_requirements)
+    return {"name": "Run 'pytest'", "uses": "dycw/action-pytest@latest", "with": dict_}
+
+
+def run_action_random_sleep_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    min: int = 0,  # noqa: A002
+    max: int = 3600,  # noqa: A002
+    step: int = 1,
+    log_freq: int = 1,
+) -> StrDict:
+    dict_: StrDict = {
+        "token": token,
+        "min": min,
+        "max": max,
+        "step": step,
+        "log-freq": log_freq,
+    }
+    return {
+        "name": actions.random_sleep.doc.DOCSTRING,
+        "uses": "dycw/action-random-sleep@latest",
+        "with": dict_,
+    }
+
+
+def run_action_ruff_dict(*, token: str = GITHUB_TOKEN) -> StrDict:
+    dict_: StrDict = {"token": token}
+    return {"name": "Run 'ruff'", "uses": "dycw/action-ruff@latest", "with": dict_}
+
+
+def run_action_tag_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    user_name: str = "github-actions-bot",
+    user_email: str = "noreply@github.com",
+    major_minor: bool = False,
+    major: bool = False,
+    latest: bool = False,
+) -> StrDict:
+    dict_: StrDict = {"token": token, "user-name": user_name, "user-email": user_email}
+    _add_boolean(dict_, "major-minor", value=major_minor)
+    _add_boolean(dict_, "major", value=major)
+    _add_boolean(dict_, "latest", value=latest)
+    return {
+        "name": actions.tag_commit.doc.DOCSTRING,
+        "uses": "dycw/action-tag-commit@latest",
+        "with": dict_,
+    }
+
+
+def _add_boolean(dict_: StrDict, key: str, /, *, value: bool = False) -> None:
+    if value:
+        dict_[key] = value
+
+
+def _add_item(dict_: StrDict, key: str, /, *, value: Any | None = None) -> None:
+    if value is not None:
+        dict_[key] = value
+
+
+def _add_native_tls(dict_: StrDict, /, *, native_tls: bool = False) -> None:
+    _add_boolean(dict_, "native-tls", value=native_tls)
+
+
+def _add_python_version(
+    dict_: StrDict, /, *, python_version: str | None = None
+) -> None:
+    _add_item(dict_, "python-version", value=python_version)
+
+
+def _add_with_requirements(
+    dict_: StrDict, /, *, with_requirements: str | None = None
+) -> None:
+    _add_item(dict_, "with-requirements", value=with_requirements)
+
+
+def _runner(*, gitea: bool = False) -> str:
+    return "gitea" if gitea else "github"
+
+
+__all__ = [
+    "run_action_pre_commit_dict",
+    "run_action_publish_dict",
+    "run_action_pyright_dict",
+    "run_action_pytest_dict",
+    "run_action_random_sleep_dict",
+    "run_action_ruff_dict",
+    "run_action_tag_dict",
+]

actions/clean_dir/cli.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+from rich.pretty import pretty_repr
+from typed_settings import click_options
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+from utilities.text import strip_and_dedent
+
+from actions import __version__
+from actions.clean_dir.lib import clean_dir
+from actions.clean_dir.settings import Settings
+from actions.logging import LOGGER
+from actions.utilities import LOADER
+
+
+@click_options(Settings, [LOADER], show_envvars_in_help=True)
+def clean_dir_sub_cmd(settings: Settings, /) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+            %s
+        """),
+        clean_dir.__name__,
+        __version__,
+        pretty_repr(settings),
+    )
+    clean_dir(dir_=settings.dir)
+
+
+__all__ = ["clean_dir_sub_cmd"]

actions/clean_dir/lib.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from pathlib import Path
+from shutil import rmtree
+from typing import TYPE_CHECKING
+
+from utilities.text import strip_and_dedent
+
+from actions import __version__
+from actions.clean_dir.settings import SETTINGS
+from actions.logging import LOGGER
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+    from utilities.types import PathLike
+
+
+def clean_dir(*, dir_: PathLike = SETTINGS.dir) -> None:
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - dir = %s
+        """),
+        clean_dir.__name__,
+        __version__,
+        dir_,
+    )
+    dir_ = Path(dir_)
+    if not dir_.is_dir():
+        msg = f"{str(dir_)!r} is a not a directory"
+        raise NotADirectoryError(msg)
+    while True:
+        files = list(_yield_files(dir_=dir_))
+        if len(files) >= 1:
+            for f in files:
+                f.unlink(missing_ok=True)
+        dirs = list(_yield_dirs(dir_=dir_))
+        if len(dirs) >= 1:
+            for d in dirs:
+                rmtree(d, ignore_errors=True)
+        else:
+            LOGGER.info("Finished cleaning %r", str(dir_))
+            return
+
+
+def _yield_dirs(*, dir_: PathLike = SETTINGS.dir) -> Iterator[Path]:
+    for path in Path(dir_).rglob("**/*"):
+        if path.is_dir() and (len(list(path.iterdir())) == 0):
+            yield path
+
+
+def _yield_files(*, dir_: PathLike = SETTINGS.dir) -> Iterator[Path]:
+    dir_ = Path(dir_)
+    yield from dir_.rglob("**/*.pyc")
+    yield from dir_.rglob("**/*.pyo")
+
+
+__all__ = ["clean_dir"]

actions/clean_dir/settings.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from typed_settings import load_settings, option, settings
+
+from actions.utilities import LOADER
+
+
+@settings
+class Settings:
+    dir: Path = option(default=Path.cwd(), help="The directory to clean")
+
+
+SETTINGS = load_settings(Settings, [LOADER])
+
+
+__all__ = ["SETTINGS", "Settings"]

actions/cli.py

@@ -3,18 +3,56 @@ from __future__ import annotations
 from click import group
 from utilities.click import CONTEXT_SETTINGS
 
-from actions.publish.cli import publish_sub_cmd
-from actions.sleep.cli import sleep_sub_cmd
-from actions.tag.cli import tag_sub_cmd
+import actions.publish_package.doc
+import actions.random_sleep.doc
+import actions.run_hooks.doc
+import actions.tag_commit.doc
+from actions.clean_dir.cli import clean_dir_sub_cmd
+from actions.conformalize_repo.cli import conformalize_repo_sub_cmd
+from actions.format_requirements.cli import format_requirements_sub_cmd
+from actions.publish_package.cli import publish_package_sub_cmd
+from actions.random_sleep.cli import random_sleep_sub_cmd
+from actions.replace_sequence_strs.cli import sequence_strs_sub_cmd
+from actions.run_hooks.cli import run_hooks_sub_cmd
+from actions.setup_cronjob.cli import setup_cronjob_sub_cmd
+from actions.tag_commit.cli import tag_commit_sub_cmd
 
 
 @group(**CONTEXT_SETTINGS)
 def _main() -> None: ...
 
 
-_ = _main.command(name="publish", **CONTEXT_SETTINGS)(publish_sub_cmd)
-_ = _main.command(name="sleep", **CONTEXT_SETTINGS)(sleep_sub_cmd)
-_ = _main.command(name="tag", **CONTEXT_SETTINGS)(tag_sub_cmd)
+_ = _main.command(name="clean-dir", help="Clean a directory", **CONTEXT_SETTINGS)(
+    clean_dir_sub_cmd
+)
+_ = _main.command(
+    name="conformalize-repo", help="Conformalize a repo", **CONTEXT_SETTINGS
+)(conformalize_repo_sub_cmd)
+_ = _main.command(
+    name="format-requirements", help="Format a set of requirements", **CONTEXT_SETTINGS
+)(format_requirements_sub_cmd)
+_ = _main.command(
+    name="publish-package",
+    help=actions.publish_package.doc.DOCSTRING,
+    **CONTEXT_SETTINGS,
+)(publish_package_sub_cmd)
+_ = _main.command(
+    name="replace-sequence-strs",
+    help="Replace 'Sequence[str]' with 'list[str]'",
+    **CONTEXT_SETTINGS,
+)(sequence_strs_sub_cmd)
+_ = _main.command(
+    name="run-hooks", help=actions.run_hooks.doc.DOCSTRING, **CONTEXT_SETTINGS
+)(run_hooks_sub_cmd)
+_ = _main.command(
+    name="random-sleep", help=actions.random_sleep.doc.DOCSTRING, **CONTEXT_SETTINGS
+)(random_sleep_sub_cmd)
+_ = _main.command(name="setup-cronjob", help="Setup a cronjob", **CONTEXT_SETTINGS)(
+    setup_cronjob_sub_cmd
+)
+_ = _main.command(
+    name="tag-commit", help=actions.tag_commit.doc.DOCSTRING, **CONTEXT_SETTINGS
+)(tag_commit_sub_cmd)
 
 
 if __name__ == "__main__":

actions/conformalize_repo/cli.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from rich.pretty import pretty_repr
+from typed_settings import click_options
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+from utilities.text import strip_and_dedent
+
+from actions import __version__
+from actions.conformalize_repo.lib import conformalize_repo
+from actions.conformalize_repo.settings import Settings
+from actions.logging import LOGGER
+from actions.utilities import LOADER
+
+
+@click_options(Settings, [LOADER], show_envvars_in_help=True)
+def conformalize_repo_sub_cmd(settings: Settings, /) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+            %s
+        """),
+        conformalize_repo.__name__,
+        __version__,
+        pretty_repr(settings),
+    )
+    conformalize_repo(
+        coverage=settings.coverage,
+        description=settings.description,
+        envrc=settings.envrc,
+        envrc__uv=settings.envrc__uv,
+        envrc__uv__native_tls=settings.envrc__uv__native_tls,
+        github__pull_request__pre_commit=settings.github__pull_request__pre_commit,
+        github__pull_request__pre_commit__gitea=settings.github__pull_request__pre_commit__gitea,
+        github__pull_request__pyright=settings.github__pull_request__pyright,
+        github__pull_request__pytest__macos=settings.github__pull_request__pytest__macos,
+        github__pull_request__pytest__ubuntu=settings.github__pull_request__pytest__ubuntu,
+        github__pull_request__pytest__windows=settings.github__pull_request__pytest__windows,
+        github__pull_request__ruff=settings.github__pull_request__ruff,
+        github__push__publish=settings.github__push__publish,
+        github__push__tag=settings.github__push__tag,
+        github__push__tag__major=settings.github__push__tag__major,
+        github__push__tag__major_minor=settings.github__push__tag__major_minor,
+        github__push__tag__latest=settings.github__push__tag__latest,
+        gitignore=settings.gitignore,
+        package_name=settings.package_name,
+        pre_commit__dockerfmt=settings.pre_commit__dockerfmt,
+        pre_commit__prettier=settings.pre_commit__prettier,
+        pre_commit__python=settings.pre_commit__python,
+        pre_commit__ruff=settings.pre_commit__ruff,
+        pre_commit__shell=settings.pre_commit__shell,
+        pre_commit__taplo=settings.pre_commit__taplo,
+        pre_commit__uv=settings.pre_commit__uv,
+        pre_commit__uv__script=settings.pre_commit__uv__script,
+        pyproject=settings.pyproject,
+        pyproject__project__optional_dependencies__scripts=settings.pyproject__project__optional_dependencies__scripts,
+        pyproject__tool__uv__indexes=settings.pyproject__tool__uv__indexes,
+        pyright=settings.pyright,
+        pytest=settings.pytest,
+        pytest__asyncio=settings.pytest__asyncio,
+        pytest__ignore_warnings=settings.pytest__ignore_warnings,
+        pytest__timeout=settings.pytest__timeout,
+        python_package_name=settings.python_package_name,
+        python_version=settings.python_version,
+        readme=settings.readme,
+        repo_name=settings.repo_name,
+        ruff=settings.ruff,
+        run_version_bump=settings.run_version_bump,
+        script=settings.script,
+    )
+
+
+__all__ = ["conformalize_repo_sub_cmd"]

actions/conformalize_repo/configs/gitignore

@@ -0,0 +1,244 @@
+#### STANDARD GITIGNORE #######################################################
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+#### END OF STANDARD GITIGNORE ################################################
+
+#### CUSTOM GITIGNORE #########################################################
+
+**/*.csv
+**/*.db
+**/*.gz
+**/*.html
+**/*.ipc
+**/*.ipynb
+**/*.pdf
+**/*.pickle
+**/*.shelf
+**/*.sqlite
+**/*.tar.gz
+**/*.tar.lz
+**/*.tmp
+.direnv/
+.logs/
+htmls/
+ipcs/
+pdfs/
+pickles/
+shelves/
+tmp/
+
+#### END OF CUSTOM GITIGNORE ##################################################