makefiles-cli 1.0.0__py3-none-any.whl

makefiles/utils/fileutils.py

@@ -0,0 +1,113 @@
+import pathlib
+import shutil
+
+import makefiles.exceptions as exceptions
+import makefiles.types as custom_types
+import makefiles.utils as utils
+import makefiles.utils.cli_io as cli_io
+
+
+def _remove_path(path: pathlib.Path) -> None:
+    """
+    Remove/Unlink `path` recursively.
+    """
+    try:
+        if utils.isfile(path) or utils.islink(path) or utils.isbrokenlink(path):
+            path.unlink(missing_ok=True)
+        elif utils.isdir(path):
+            shutil.rmtree(path)
+    except FileNotFoundError:
+        pass
+
+
+def copy(
+    src: pathlib.Path,
+    *dests: pathlib.Path,
+    overwrite: bool = False,
+    parents: bool = False,
+) -> custom_types.ExitCode:
+    """
+    Copies a source file or symbolic link to one or more destination paths.
+
+    Args:
+        src (pathlib.Path): Path to the source file. Must be a regular file or a symlink to a file.
+        *dests (pathlib.Path): One or more destination paths to copy the source to.
+        overwrite (bool, optional): If True, existing destination files will be overwritten.
+                                    If False (default), print an error message and be skip.
+        parents (bool, optional): If True, create parent(s) if not already exists.
+                                  If False (default), print an error message and skip.
+
+    Returns:
+        custom_types.ExitCode: Exit code 0 if all copies succeed.
+                               Returns 1 if any destination exists and overwrite is False.
+
+    Raises:
+        makefiles.exceptions.SourceNotFoundError: If the source path does not exist.
+        makefiles.exceptions.InvalidSourceError: If the source is not a file or a symbolic link to a file.
+    """
+    exitcode: custom_types.ExitCode = custom_types.ExitCode(0)
+
+    if not utils.exists(src):
+        raise exceptions.SourceNotFoundError(f"source {str(src)} does not exists")
+    elif not (utils.isfile(src) or utils.islinkf(src)):
+        raise exceptions.InvalidSourceError(f"source {str(src)} is not a file or a link to file")
+
+    for dest in dests:
+        if utils.exists(dest) and not overwrite:
+            cli_io.eprint(f"destination {str(dest)} already exists\n")
+            exitcode = custom_types.ExitCode(1) or exitcode
+            continue
+
+        dest_parent: pathlib.Path = dest.parent
+        if not (utils.isdir(dest_parent) or utils.islinkd(dest_parent)) and not parents:
+            cli_io.eprint(f"parent dir {str(dest_parent)} does not exists\n")
+            exitcode = custom_types.ExitCode(1) or exitcode
+            continue
+
+        _remove_path(dest)
+        dest_parent.mkdir(parents=True, exist_ok=True)
+
+        shutil.copyfile(src, dest, follow_symlinks=True)
+
+    return exitcode
+
+
+def create_empty_files(
+    *paths: pathlib.Path,
+    overwrite: bool = False,
+    parents: bool = False,
+) -> custom_types.ExitCode:
+    """
+    Creates empty files at the specified paths, optionally overwriting existing files or directories.
+
+    Args:
+        *paths (pathlib.Path): One or more paths where empty files should be created.
+        overwrite (bool, optional): If True, existing destination files will be overwritten.
+                                    If False (default), print an error message and be skip.
+        parents (bool, optional): If True, create parent(s) if not already exists.
+                                  If False (default), print an error message and skip.
+
+    Returns:
+        makefiles.types.ExitCode: Exit code 0 on full success.
+                                  Exit code 1 if any file already exists and overwrite is False.
+    """
+    exitcode: custom_types.ExitCode = custom_types.ExitCode(0)
+
+    for path in paths:
+        if utils.exists(path) and not overwrite:
+            cli_io.eprint(f"destination {path} already exists\n")
+            exitcode = custom_types.ExitCode(1) or exitcode
+            continue
+
+        path_parent: pathlib.Path = path.parent
+        if not (utils.isdir(path_parent) or utils.islinkd(path_parent)) and not parents:
+            cli_io.eprint(f"parent dir {str(path_parent)} does not exists\n")
+            exitcode = custom_types.ExitCode(1) or exitcode
+            continue
+
+        _remove_path(path)
+        path_parent.mkdir(parents=True, exist_ok=True)
+
+        path.touch(exist_ok=False)
+
+    return exitcode

makefiles/utils/picker/__init__.py

@@ -0,0 +1,7 @@
+from makefiles.utils.picker.fzf import prompt as fzf
+from makefiles.utils.picker.manual import prompt as manual
+
+__all__: list[str] = [
+    "fzf",
+    "manual",
+]

makefiles/utils/picker/fzf.py

@@ -0,0 +1,48 @@
+import shutil
+import subprocess
+
+import makefiles.exceptions as exceptions
+import makefiles.types as custom_types
+
+FZF_DEFAULT_FLAGS: list[str] = [
+    "--style=minimal",
+    "--info=hidden",
+    "--keep-right",
+]
+
+
+def prompt(options: list[str], *, height: custom_types.NaturalNumber = custom_types.NaturalNumber(10)) -> str:
+    """
+    Displays an interactive fuzzy-selection prompt using `fzf` and returns the user's selection.
+
+    Args:
+        options (list[str]): A list of string options to display in the selection interface.
+        height (custom_types.NaturalNumber, optional): Approximate terminal height percentage for the `fzf` UI.
+            Defaults to 10. The value is interpreted as `--height=~<value>` by `fzf`.
+
+    Returns:
+        str: The selected option as returned by `fzf`, with trailing newline removed.
+
+    Raises:
+        exceptions.FZFNotFoundError: If the `fzf` binary is not found in the system PATH.
+        KeyboardInterrupt: If the user interrupts the prompt using Ctrl+C (fzf returns exit code 130).
+        exceptions.FZFError: If `fzf` exits with a non-zero return code other than 130.
+    """
+    if not shutil.which("fzf"):
+        raise exceptions.FZFNotFoundError("`fzf` is not found in path")
+
+    options_str: str = "\n".join(options)
+
+    process: subprocess.CompletedProcess = subprocess.run(
+        ["fzf", *FZF_DEFAULT_FLAGS, f"--height=~{int(height)}"],
+        input=options_str,
+        text=True,
+        capture_output=True,
+    )
+
+    if process.returncode != 0:
+        if process.returncode == 130:
+            raise KeyboardInterrupt
+        raise exceptions.FZFError("`fzf` command returned non zero exit code")
+
+    return process.stdout.strip("\n")

makefiles/utils/picker/manual.py

@@ -0,0 +1,29 @@
+import makefiles.types as custom_types
+import makefiles.utils.cli_io as cli_io
+
+
+def prompt(options: list[str]) -> str:
+    """
+    Displays a numbered list of options and prompts the user to select one via keyboard input.
+
+    Args:
+        options (list[str]): A list of string options to present to the user for selection.
+
+    Returns:
+        str: The selected option from the list, based on user input.
+    """
+    options = sorted(options)  # do not modify the parameter
+
+    for index, option in enumerate(options, start=1):
+        cli_io.print(f"[{index}]: {option}\n")
+
+    while True:
+        try:
+            cli_io.print("Choose a template: ")
+            choice: custom_types.NaturalNumber = custom_types.NaturalNumber(cli_io.input())
+            assert choice <= len(options)
+            break
+        except (ValueError, TypeError, AssertionError):
+            cli_io.eprint("Please insert a valid input\n")
+
+    return options[choice - 1]

makefiles_cli-1.0.0.data/scripts/mkfile

@@ -0,0 +1,8 @@
+#!python
+
+import sys
+
+from makefiles.mkfile import main
+
+if __name__ == "__main__":
+    sys.exit(main())

makefiles_cli-1.0.0.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: makefiles-cli
+Version: 1.0.0
+Summary: A lightweight Python utility for file creation and template generation from XDG_TEMPLATES_DIR
+License-Expression: GPL-3.0-only
+Project-URL: Homepage, https://github.com/Rid1FZ/makefiles-cli
+Keywords: makefiles,mkfiles,mkfile,makefiles-cli,mkfile-cli
+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: Operating System :: POSIX :: Linux
+Classifier: Environment :: Console
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# makefiles-cli - Command line interface for XDG_TEMPLATES_DIR
+
+`makefiles-cli` is a simple commandline tool to create files and templates. It can create one or more empty files or any template defined in `XDG_TEMPLATES_DIR`. It also has support for [fzf](https://github.com/junegunn/fzf) to make it easier to find template.
+
+## Usage
+
+Create empty files:
+
+```bash
+mkfile example1 example2
+```
+
+List all available templates:
+
+```bash
+mkfile --list
+```
+
+Create template from any template defined in `XDG_TEMPLATES_DIR`:
+
+```bash
+mkfile script.py --template="pyscript.py"
+```
+
+Create template using `fzf` as picker to pick template interactively:
+
+```bash
+mkfile script.py --template --picker="fzf"
+```
+
+Run `mkfile --help` for all the available options.
+
+## Installation
+
+_Requirements_:
+
+- python3 (python3.10 or greater)
+- pip
+
+You can install `makefiles-cli` directly from **PyPI** using `pip`:
+
+```bash
+pip install makefiles-cli
+```
+
+Or if you love to stay on bleeding edge, install directly from github:
+
+```bash
+pip install git+https://github.com/Rid1FZ/makefiles-cli
+```

makefiles_cli-1.0.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+makefiles/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+makefiles/_version.py,sha256=fo5PXsZuloQZu3LdpIFTUAXvJmY2L9N5sNGe2tvdU98,511
+makefiles/cli_parser.py,sha256=cCpL3sR7pQkbh8J2YyNYFXYs5EYDuciLBQID7ghQbPk,2041
+makefiles/exceptions.py,sha256=oQXWabm6iFFmSpsSZRp1Q6Fmlgl-NmKVInPQlFmrBkg,2034
+makefiles/mkfile.py,sha256=YlOFs7mpd0deDHP-auSnmBet8AYQPk84-Eu9--d1aHY,4041
+makefiles/types.py,sha256=f52KuUyNpKLdn2V8EWdL2zaz60zK9PDsUuVyGkdnX-w,2479
+makefiles/utils/__init__.py,sha256=UPjxn9bLa6qtWGZGrLseGiCQPRGPPh4p8rX40KoK-nk,3870
+makefiles/utils/cli_io.py,sha256=hWWsiE5pdyJtl4_MKK15hRckdG6YHwAbIppUWOhTHo4,2561
+makefiles/utils/dirwalker.py,sha256=nRJaAzbXT5VOAjZMl97B7jlFo5U962YGeDd2OU476_s,1225
+makefiles/utils/fileutils.py,sha256=9yfbbofwWSxqQhTqSstkme-hZICyCGv_DFSHNTmsIbU,4301
+makefiles/utils/picker/__init__.py,sha256=PLvX88I1vEer2-fnM7vOPk0RnSsmg4flc-ak5qSvpq0,163
+makefiles/utils/picker/fzf.py,sha256=pjXRyQP7s7z-Ev8zM_h6mNsRCWECKrXDUI1kdCCO1p4,1714
+makefiles/utils/picker/manual.py,sha256=IejYYqLDUwaRVAYTKA3VHR5zDaWJFbbQzKLlmN5SPJY,957
+makefiles_cli-1.0.0.data/scripts/mkfile,sha256=tBmA2Skc-0YD8uq_DxdLmxPLUQpGspPR1xHzQRUL968,105
+makefiles_cli-1.0.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+makefiles_cli-1.0.0.dist-info/METADATA,sha256=9gtQHcMrMH866G2q21DpHhYltoOpfz1EoH1AE2RMwIo,1816
+makefiles_cli-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+makefiles_cli-1.0.0.dist-info/top_level.txt,sha256=_LWvFR-XPibPQepQ4yMZlEJyTQZgOtjVo1m0V9GFcxw,10
+makefiles_cli-1.0.0.dist-info/RECORD,,

makefiles_cli-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+