batchfetch 1.2.8__tar.gz → 1.3.0__tar.gz

{batchfetch-1.2.8 → batchfetch-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.2.8
+Version: 1.3.0
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -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.8 → batchfetch-1.3.0}/README.md

@@ -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.8 → batchfetch-1.3.0}/batchfetch/batchfetch_base.py

@@ -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.8 → batchfetch-1.3.0}/batchfetch/batchfetch_cli.py

@@ -298,6 +298,12 @@ class BatchFetchCli:
 
 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.8 → batchfetch-1.3.0}/batchfetch/batchfetch_git.py

@@ -59,7 +59,6 @@ class BatchFetchGit(TaskBatchFetch):
             # Local options
             self.main_key: str,
             Optional("revision"): str,
-            Optional("reference"): str,
 
             # Same as global options
             Optional("git_clone_args"): [str],
@@ -104,11 +103,6 @@ class BatchFetchGit(TaskBatchFetch):
         """Clone or update a Git repository."""
         super().update()
 
-        # Backward compatibility
-        if "reference" in self._item_values \
-                and "revision" not in self._item_values:
-            self._item_values["revision"] = "reference"
-
         is_clone = False
         if not self.git_local_dir.exists():
             is_clone = True
@@ -139,9 +133,20 @@ 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(
+                        "git symbolic-ref refs/remotes/origin/HEAD"
+                    ).split("/")[-1]
+                    if not self["revision"]:
+                        raise BatchFetchError(
+                            "Unable to determine the default origin branch"
+                        )
 
-                # self._repo_reset()
+                    self.add_output(self.indent_spaces +
+                                    f"[INFO] Update revision to: '" +
+                                    self["revision"] + "'\n")
 
                 git_fetch_done = self._repo_fetch()
 
@@ -152,11 +157,8 @@ class BatchFetchGit(TaskBatchFetch):
                 if git_fetch_done:
                     git_merge_done = self._git_merge()
 
-                # if (git_fetch_done and git_merge_done) or git_branch_changed:
-                #     self._repo_update_submodules()
-
                 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")
@@ -173,6 +175,13 @@ class BatchFetchGit(TaskBatchFetch):
 
         return self.values
 
+    def _run_get_firstline(self, *args, **kwargs):
+        stdout, _ = self._run(*args, **kwargs)
+        try:
+            return stdout[0]
+        except IndexError:
+            return ""
+
     def _run(self, cmd: Union[List[str], str],
              cwd: Union[None, os.PathLike] = None,
              env: Union[None, dict] = None,
@@ -251,50 +260,38 @@ class BatchFetchGit(TaskBatchFetch):
         self._run(cmd, cwd=".")
         self.set_changed(True)
 
-    def _repo_reset(self):
-        # Remove local changes
-        cmd = ["git", "reset", "--hard", "HEAD"]
-        self._run(cmd, cwd=".")
-
     def _repo_fetch(self):
         # Merge
         do_git_fetch = self["git_pull"]
-        if not self["revision"]:
+        do_git_fetch = False
+        commit_ref = None
+
+        try:
+            # Check if the revision such as
+            stdout, _ = self._run(["git", "cat-file", "-e", self["revision"]])
+        except subprocess.CalledProcessError:
             do_git_fetch = True
-            self.add_output(self.indent_spaces
-                            + "[INFO] Git fetch origin reason: "
-                            + "No 'revision:' specified\n")
-        else:
-            do_git_fetch = False
-            commit_ref = None
+            self.add_output(
+                self.indent_spaces
+                + "[INFO] Git fetch origin reason: "
+                + f"The revision does not exist: {self['revision']}"
+                + "\n")
 
+        # The revision exists, but if it a branch, git pull anyway
+        if not do_git_fetch:
             try:
-                # Check if the revision such as
-                stdout, _ = self._run(["git", "cat-file", "-e",
-                                       self["revision"]])
-            except subprocess.CalledProcessError:
-                do_git_fetch = True
+                # Check if the branch is a tag or a branch
+                cmd = ["git", "show-ref", "--verify", "--quiet",
+                       f"refs/heads/{self['revision']}"]
+                self._run(cmd)
                 self.add_output(
                     self.indent_spaces
                     + "[INFO] Git fetch origin reason: "
-                    + f"The revision does not exist: {self['revision']}"
+                    + f"{self['revision']} is a branch, not a tag"
                     + "\n")
-
-            # The revision exists, but if it a branch, git pull anyway
-            if not do_git_fetch:
-                try:
-                    # Check if the branch is a tag or a branch
-                    cmd = ["git", "show-ref", "--verify", "--quiet",
-                           f"refs/heads/{self['revision']}"]
-                    self._run(cmd)
-                    self.add_output(
-                        self.indent_spaces
-                        + "[INFO] Git fetch origin reason: "
-                        + f"{self['revision']} is a branch, not a tag"
-                        + "\n")
-                    do_git_fetch = True
-                except subprocess.CalledProcessError:
-                    pass
+                do_git_fetch = True
+            except subprocess.CalledProcessError:
+                pass
 
         if not do_git_fetch:
             self.add_output(self.indent_spaces + "[INFO] git fetch ignored\n")

{batchfetch-1.2.8 → batchfetch-1.3.0}/batchfetch.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.2.8
+Version: 1.3.0
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -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.8 → batchfetch-1.3.0}/setup.py

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