batchfetch 1.2.9__tar.gz → 1.3.1__tar.gz

{batchfetch-1.2.9 → batchfetch-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.2.9
+Version: 1.3.1
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -117,13 +117,13 @@ The parent directory of the "path:" value defines the managed directory, where t
 
 For example, if the "path:" value is `file/my-project`, the managed directory will be `file/`. Any file within `file/` that is not managed by batchfetch will be considered an untracked file.
 
-When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked_paths` list, enabling users to manage untracked files effectively.
+When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked` list, enabling users to manage untracked files effectively.
 
 Here is an example of a *batchfetch.yaml* file that enables *batchfetch* to accept a list of untracked files:
 
 ``` yaml
 options:
-  ignore_untracked_paths:
+  ignore_untracked:
     - ./test
     - /absolute/path
     - ../relative/path
@@ -132,7 +132,7 @@ tasks:
   - git: https://github.com/user/project
 ```
 
-By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked_paths* option.
+By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked* option.
 
 ### How is the Git local paths handled?
 
@@ -196,6 +196,21 @@ batchfetch easysession
 
 This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yml` file.
 
+### How can I configure batchfetch to load a file other than batchfetch.yaml?
+
+You can specify the configuration file using the `-f` command-line option:
+
+```yaml
+batchfetch -f alternative-batchfetch.yaml
+```
+
+Alternatively, you can set the `BATCHFETCH_FILE` environment variable:
+
+```bash
+export BATCHFETCH_FILE=alternative-batchfetch.yaml
+batchfetch
+```
+
 ## License
 
 Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)

{batchfetch-1.2.9 → batchfetch-1.3.1}/README.md

@@ -97,13 +97,13 @@ The parent directory of the "path:" value defines the managed directory, where t
 
 For example, if the "path:" value is `file/my-project`, the managed directory will be `file/`. Any file within `file/` that is not managed by batchfetch will be considered an untracked file.
 
-When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked_paths` list, enabling users to manage untracked files effectively.
+When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked` list, enabling users to manage untracked files effectively.
 
 Here is an example of a *batchfetch.yaml* file that enables *batchfetch* to accept a list of untracked files:
 
 ``` yaml
 options:
-  ignore_untracked_paths:
+  ignore_untracked:
     - ./test
     - /absolute/path
     - ../relative/path
@@ -112,7 +112,7 @@ tasks:
   - git: https://github.com/user/project
 ```
 
-By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked_paths* option.
+By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked* option.
 
 ### How is the Git local paths handled?
 
@@ -176,6 +176,21 @@ batchfetch easysession
 
 This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yml` file.
 
+### How can I configure batchfetch to load a file other than batchfetch.yaml?
+
+You can specify the configuration file using the `-f` command-line option:
+
+```yaml
+batchfetch -f alternative-batchfetch.yaml
+```
+
+Alternatively, you can set the `BATCHFETCH_FILE` environment variable:
+
+```bash
+export BATCHFETCH_FILE=alternative-batchfetch.yaml
+batchfetch
+```
+
 ## License
 
 Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)

{batchfetch-1.2.9 → batchfetch-1.3.1}/batchfetch/batchfetch_base.py

@@ -107,7 +107,7 @@ class TaskBatchFetch(TaskBase):
         self.global_options_schema: Dict[Any, Any] = {
             Optional("exec_before"): Or([str], str),
             Optional("exec_after"): Or([str], str),
-            Optional("ignore_untracked_paths"): Or([str], str),
+            Optional("ignore_untracked"): Or([str], str),
         }
 
         self.task_schema: Dict[Any, Any] = {
@@ -121,7 +121,7 @@ class TaskBatchFetch(TaskBase):
         self.global_options_values: Dict[str, Any] = {
             "exec_before": [],
             "exec_after": [],
-            "ignore_untracked_paths": [],
+            "ignore_untracked": [],
         }
 
         self.task_default_values: Dict[str, Any] = {
@@ -138,28 +138,44 @@ class TaskBatchFetch(TaskBase):
         # Mark values as initialized
         self._values_initialized = True
 
-    def _pre_run(self, *args, **kwargs):
-        stdout = run_indent_str(*args, **kwargs)
-
+    def _local_task_exec(self, *args, **kwargs):
+        stdout = run_indent_str(env=self.env, spaces=self.indent,
+                                *args, **kwargs)
         if not stdout.endswith("\n"):
             stdout += "\n"
         self.add_output(stdout)
 
-    def _run_pre_exec(self, cwd: os.PathLike = Path(".")):
+    def _exec_before(self, cwd: os.PathLike = Path(".")):
         self._initialize_data()
-        cmd = self["exec_before"]
-        if self["delete"] or not cmd:
+        if self["delete"]:
             return
 
-        self._pre_run(cmd, cwd=str(cwd), env=self.env, spaces=self.indent)
+        # Global
+        cmd = self.options["exec_before"] \
+            if "exec_before" in self.options else None
+        if cmd:
+            self._local_task_exec(cmd, cwd=str(cwd))
+
+        # Local
+        cmd = self["exec_before"]
+        if cmd:
+            self._local_task_exec(cmd, cwd=str(cwd))
 
-    def _run_post_exec(self, cwd: os.PathLike = Path(".")):
+    def _exec_after(self, cwd: os.PathLike = Path(".")):
         self._initialize_data()
-        cmd = self["exec_after"]
-        if not cmd or self["delete"] or not self.is_changed():
+        if self["delete"] or not self.is_changed():
             return
 
-        self._pre_run(cmd, cwd=str(cwd), env=self.env, spaces=self.indent)
+        # Local
+        cmd = self.options["exec_after"] \
+            if "exec_after" in self.options else None
+        if cmd:
+            self._local_task_exec(cmd, cwd=str(cwd))
+
+        # Local
+        cmd = self["exec_after"]
+        if cmd:
+            self._local_task_exec(cmd, cwd=str(cwd))
 
     def is_changed(self) -> bool:
         self._initialize_data()

{batchfetch-1.2.9 → batchfetch-1.3.1}/batchfetch/batchfetch_cli.py

@@ -47,7 +47,7 @@ class BatchFetchCli:
         self.cfg: dict = {}
         self.check_untracked = check_untracked
         self.tracked_paths: Dict[Path, Set[str]] = {}
-        self.ignore_untracked_paths: Set[Path] = set()
+        self.ignore_untracked: Set[Path] = set()
         self.verbose = verbose
         self.max_workers = max_workers
         self.dirs_relative_to_batchfetch: Set[str] = set()
@@ -100,20 +100,20 @@ class BatchFetchCli:
                           file=sys.stderr)
                     sys.exit(1)
 
-                self.ignore_untracked_paths.add(Path(path).absolute())
-                self.ignore_untracked_paths.add(Path(path).resolve())
+                self.ignore_untracked.add(Path(path).absolute())
+                self.ignore_untracked.add(Path(path).resolve())
                 untracked_paths = None
                 if "options" in yaml_dict and \
-                        "ignore_untracked_paths" in yaml_dict["options"]:
+                        "ignore_untracked" in yaml_dict["options"]:
                     untracked_paths = \
-                        yaml_dict["options"]["ignore_untracked_paths"]
+                        yaml_dict["options"]["ignore_untracked"]
 
                 if isinstance(untracked_paths, str):
                     untracked_paths = [untracked_paths]
 
                 if untracked_paths:
                     for ignore_untracked_path in untracked_paths:
-                        self.ignore_untracked_paths.add(
+                        self.ignore_untracked.add(
                             Path(ignore_untracked_path).absolute()
                         )
 
@@ -277,7 +277,7 @@ class BatchFetchCli:
             actual_filenames = {file.name for file in tracked_dir.iterdir()}
             for filename in actual_filenames - tracked_filenames:
                 full_path = tracked_dir / filename
-                if full_path in self.ignore_untracked_paths:
+                if full_path in self.ignore_untracked:
                     continue
 
                 untracked_paths.add(full_path)
@@ -291,13 +291,19 @@ class BatchFetchCli:
                             "\n")
             err_str += ("The paths above are not managed by batchfetch."
                         " To retain them, add them to the "
-                        "options.ignore_untracked_paths list, using either "
+                        "options.ignore_untracked list, using either "
                         "relative or absolute paths")
             raise BatchFetchError(err_str)
 
 
 def parse_args():
     """Parse the command line arguments."""
+    # Batchfetch file
+    try:
+        batchfetch_file = os.environ["BATCHFETCH_FILE"]
+    except KeyError:
+        batchfetch_file = None
+
     # Jobs
     try:
         jobs = os.environ["BATCHFETCH_JOBS"]
@@ -326,12 +332,16 @@ def parse_args():
               "paths defined in the batchfetch.yml list of tasks."),
     )
 
-    parser.add_argument("-f",
-                        "--file",
-                        default=None,
-                        required=False,
-                        help=("Specify the batchfetch YAML file "
-                              "(default: './batchfetch.yaml')."))
+    parser.add_argument(
+        "-f",
+        "--file",
+        default=batchfetch_file,
+        required=False,
+        help=("Specify the batchfetch YAML file "
+              "(default: './batchfetch.yaml')."
+              "Alternatively, the BATCHFETCH_FILE environment variable can be "
+              "used to configure the number of jobs."),
+    )
 
     parser.add_argument(
         "-C",

{batchfetch-1.2.9 → batchfetch-1.3.1}/batchfetch/batchfetch_git.py

@@ -133,7 +133,7 @@ class BatchFetchGit(TaskBatchFetch):
                 # Pre exec
                 self._update_current_branch_name()
                 self._repo_fix_remote_origin()
-                self._run_pre_exec(cwd=self.git_local_dir)
+                self._exec_before(cwd=self.git_local_dir)
 
                 if not self["revision"]:
                     self.values["revision"] = self._run_get_firstline(
@@ -158,7 +158,7 @@ class BatchFetchGit(TaskBatchFetch):
                     git_merge_done = self._git_merge()
 
                 if self.get_changed():
-                    self._run_post_exec(cwd=self.git_local_dir)
+                    self._exec_after(cwd=self.git_local_dir)
         except BatchFetchError as err:
             self.set_error(True)
             self.add_output(self.indent_spaces + "[ERROR] " + str(err) + "\n")
@@ -268,8 +268,7 @@ class BatchFetchGit(TaskBatchFetch):
 
         try:
             # Check if the revision such as
-            stdout, _ = self._run(["git", "cat-file", "-e",
-                                   self["revision"]])
+            stdout, _ = self._run(["git", "cat-file", "-e", self["revision"]])
         except subprocess.CalledProcessError:
             do_git_fetch = True
             self.add_output(

{batchfetch-1.2.9 → batchfetch-1.3.1}/batchfetch.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.2.9
+Version: 1.3.1
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -117,13 +117,13 @@ The parent directory of the "path:" value defines the managed directory, where t
 
 For example, if the "path:" value is `file/my-project`, the managed directory will be `file/`. Any file within `file/` that is not managed by batchfetch will be considered an untracked file.
 
-When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked_paths` list, enabling users to manage untracked files effectively.
+When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked` list, enabling users to manage untracked files effectively.
 
 Here is an example of a *batchfetch.yaml* file that enables *batchfetch* to accept a list of untracked files:
 
 ``` yaml
 options:
-  ignore_untracked_paths:
+  ignore_untracked:
     - ./test
     - /absolute/path
     - ../relative/path
@@ -132,7 +132,7 @@ tasks:
   - git: https://github.com/user/project
 ```
 
-By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked_paths* option.
+By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked* option.
 
 ### How is the Git local paths handled?
 
@@ -196,6 +196,21 @@ batchfetch easysession
 
 This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yml` file.
 
+### How can I configure batchfetch to load a file other than batchfetch.yaml?
+
+You can specify the configuration file using the `-f` command-line option:
+
+```yaml
+batchfetch -f alternative-batchfetch.yaml
+```
+
+Alternatively, you can set the `BATCHFETCH_FILE` environment variable:
+
+```bash
+export BATCHFETCH_FILE=alternative-batchfetch.yaml
+batchfetch
+```
+
 ## License
 
 Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)

{batchfetch-1.2.9 → batchfetch-1.3.1}/setup.py

@@ -22,7 +22,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="batchfetch",
-    version="1.2.9",
+    version="1.3.1",
     packages=find_packages(),
     description="Efficiently clone and pull multiple Git repositories.",
     license="GPLv3",