batchfetch 1.0.4__tar.gz → 1.0.6__tar.gz

{batchfetch-1.0.4/batchfetch.egg-info → batchfetch-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.0.4
+Version: 1.0.6
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -17,10 +17,6 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.6, <4
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: colorama
-Requires-Dist: schema
-Requires-Dist: setproctitle
-Requires-Dist: PyYAML
 
 # Batchfetch - Efficiently clone or pull multiple Git repositories in parallel
 
@@ -61,12 +57,12 @@ tasks:
   # Clone the tag 1.5 of the consult repository to the './consult'
   # directory
   - git: https://github.com/minad/consult
-    branch: "1.5"
+    reference: "1.5"
 
   # Clone the s.el repository to the './another-name.el' directory
   - git: https://github.com/magnars/s.el
     path: another-name.el
-    branch: dda84d38fffdaf0c9b12837b504b402af910d01d
+    reference: dda84d38fffdaf0c9b12837b504b402af910d01d
 
   # Delete './impatient-mode'
   - git: https://github.com/skeeto/impatient-mode
@@ -84,14 +80,15 @@ usage: batchfetch [--option] [args]
 
 Command line interface.
 
+positional arguments:
+  N                     Specify the batchfetch YAML file(s) (default: './batchfetch.yaml').
+
 options:
   -h, --help            show this help message and exit
-  -j JOBS, --jobs JOBS
-                        Run up to N Number of parallel git processes (Default: 5).
+  -j JOBS, --jobs JOBS  Run up to N Number of parallel processes (Default: 5).
   -v, --verbose         Enable verbose mode.
-  -f BATCHFETCH_FILE, --batchfetch-file BATCHFETCH_FILE
-                        Specify the batchfetch YAML file (default: './batchfetch.yaml').
 ```
+
 ## License
 
 Copyright (c) [James Cherti](https://www.jamescherti.com)

{batchfetch-1.0.4 → batchfetch-1.0.6}/README.md

@@ -37,12 +37,12 @@ tasks:
   # Clone the tag 1.5 of the consult repository to the './consult'
   # directory
   - git: https://github.com/minad/consult
-    branch: "1.5"
+    reference: "1.5"
 
   # Clone the s.el repository to the './another-name.el' directory
   - git: https://github.com/magnars/s.el
     path: another-name.el
-    branch: dda84d38fffdaf0c9b12837b504b402af910d01d
+    reference: dda84d38fffdaf0c9b12837b504b402af910d01d
 
   # Delete './impatient-mode'
   - git: https://github.com/skeeto/impatient-mode
@@ -60,14 +60,15 @@ usage: batchfetch [--option] [args]
 
 Command line interface.
 
+positional arguments:
+  N                     Specify the batchfetch YAML file(s) (default: './batchfetch.yaml').
+
 options:
   -h, --help            show this help message and exit
-  -j JOBS, --jobs JOBS
-                        Run up to N Number of parallel git processes (Default: 5).
+  -j JOBS, --jobs JOBS  Run up to N Number of parallel processes (Default: 5).
   -v, --verbose         Enable verbose mode.
-  -f BATCHFETCH_FILE, --batchfetch-file BATCHFETCH_FILE
-                        Specify the batchfetch YAML file (default: './batchfetch.yaml').
 ```
+
 ## License
 
 Copyright (c) [James Cherti](https://www.jamescherti.com)

{batchfetch-1.0.4 → batchfetch-1.0.6}/batchfetch/__init__.py

@@ -16,8 +16,3 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 #
 """The entry-point of batchfetch."""
-
-from .batchfetch_cli import command_line_interface
-
-if __name__ == "__main__":
-    command_line_interface()

{batchfetch-1.0.4 → batchfetch-1.0.6}/batchfetch/batchfetch_base.py

@@ -10,7 +10,8 @@
 #
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
 #
 # You should have received a copy of the GNU General Public License along with
 # this program. If not, see <https://www.gnu.org/licenses/>.
@@ -31,19 +32,13 @@ class BatchFetchError(Exception):
     """Exception raised by Downloader()."""
 
 
-class GitBranchDoesNotExist(Exception):
-    """Exception raised by Name()."""
-
-
 class BatchFetchBase:
     """Plugin downloader base class."""
 
-    env = os.environ.copy()
-    env["GIT_TERMINAL_PROMPT"] = "0"
-
-    indent = 4
-
     def __init__(self, data: Dict[str, Any], options: Dict[str, Any]):
+        self.indent = 4
+        self.env = os.environ.copy()
+
         # Default
         self.global_options_schema: Dict[Any, Any] = {
             Optional("pre_exec"): Or([str], str),

{batchfetch-1.0.4 → batchfetch-1.0.6}/batchfetch/batchfetch_cli.py

@@ -10,7 +10,8 @@
 #
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
 #
 # You should have received a copy of the GNU General Public License along with
 # this program. If not, see <https://www.gnu.org/licenses/>.
@@ -24,7 +25,7 @@ import subprocess
 import sys
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from pathlib import Path
-from typing import Set
+from typing import Any, Dict, Set
 
 import colorama
 import yaml  # type: ignore
@@ -32,31 +33,13 @@ from colorama import Fore
 from schema import Optional, Or, Schema, SchemaError
 from setproctitle import setproctitle
 
-from .batchfetch_base import BatchFetchError
+from .batchfetch_base import BatchFetchBase, BatchFetchError
 from .batchfetch_git import BatchFetchGit
 
 
 class BatchFetchCli:
     """Command-line-interface that downloads."""
 
-    main_key = "git"
-
-    # TODO: Make this automatic
-    empty_downloader_git = BatchFetchGit(
-        data={main_key: "http://www.domain.com"},
-        options={},
-    )
-    empty_downloader_git.validate_schema()  # Gen structure
-
-    cfg_schema = {
-        Optional("options"):
-            empty_downloader_git.global_options_schema,  # type: ignore
-        # TODO: Make this added automatically
-        Optional("tasks"): [
-            Or(str, empty_downloader_git.item_schema)
-        ]
-    }
-
     def __init__(self, max_workers: int, verbose: bool = False):
         self.cfg: dict = {}
         self.folder = Path(".")
@@ -66,16 +49,55 @@ class BatchFetchCli:
         self._logger = logging.getLogger(self.__class__.__name__)
         self.dirs_relative_to_batchfetch: Set[str] = set()
 
+        # Plugin
+        self.batchfetch_schemas: Dict[Any, Any] = {}
+        self.batchfetch_classes: Dict[str, BatchFetchBase] = {}
+        self.cfg_schema: Dict[Any, Any] = {}
+        self._plugin_add("git", BatchFetchGit)
+
+    def _plugin_add(self, keyword: str, batchfetch_class: Any):
+        batchfetch_instance = batchfetch_class(data={},
+                                               options={})
+        batchfetch_instance.validate_schema()
+
+        self.batchfetch_schemas[keyword] = batchfetch_instance.item_schema
+        self.batchfetch_classes[keyword] = batchfetch_class
+        self.cfg_schema = {
+            Optional("options"):
+                batchfetch_instance.global_options_schema,  # type: ignore
+            Optional("tasks"): [
+                Or(*list(self.batchfetch_schemas.values()))
+            ]
+        }
+
+    def _plugin_get(self, raw_data: dict) -> str:
+        keyword_found = None
+        for keyword in self.batchfetch_classes:
+            if keyword in raw_data:
+                if keyword_found is not None:
+                    err_str = (f"The keywords {keyword} and {keyword_found} "
+                               f"are mutually exclusive. Error in: {raw_data}")
+                    raise BatchFetchError(err_str)
+                keyword_found = keyword
+
+        if not keyword_found:
+            err_str = "None of the keywords " + \
+                ", ".join(self.batchfetch_classes.keys()) + \
+                f" have been found in: {raw_data}"
+            raise BatchFetchError(err_str)
+
+        return keyword_found
+
     def load(self, path: Path):
         try:
             with open(path, "r", encoding="utf-8") as fhandler:
                 yaml_dict = yaml.load(fhandler, Loader=yaml.FullLoader)
-                self.loads(dict(yaml_dict))
+                self._loads(dict(yaml_dict))
         except OSError as err:
             raise BatchFetchError(str(err)) from err
 
-    def loads(self, data: dict):
-        schema = Schema(BatchFetchCli.cfg_schema)
+    def _loads(self, data: dict):
+        schema = Schema(self.cfg_schema)
         try:
             schema.validate(data)
         except SchemaError as err:
@@ -84,47 +106,45 @@ class BatchFetchCli:
 
         self.cfg = {
             "options": {"clone_args": []},
-            # TODO: Make this added automatically
             "tasks": [],
         }
 
         if "options" in data:
             self.cfg["options"].update(data["options"])
 
-        # TODO: Make this automatic
-        self._loads_git(data)
+        self._loads_tasks(data)
 
-    def _loads_git(self, data: dict):
+    def _loads_tasks(self, data: dict):
         if "tasks" not in data:
             return
 
         dict_local_dir = {}  # type: ignore
-        for git_repo_raw in data["tasks"]:
-            if isinstance(git_repo_raw, str):
-                git_repo_raw = {BatchFetchCli.main_key: git_repo_raw}
+        for task in data["tasks"]:
+            keyword = self._plugin_get(task)
+            batchfetch_class = self.batchfetch_classes[keyword]
 
             try:
-                plugin_downloader_git = BatchFetchGit(
-                    data=git_repo_raw,
+                batchfetch_instance = batchfetch_class(  # type: ignore
+                    data=task,
                     options=self.cfg["options"],
                 )
-                self.cfg["tasks"].append(plugin_downloader_git)
+                self.cfg["tasks"].append(batchfetch_instance)
             except SchemaError as err:
                 print(f"Schema error: {err}.", file=sys.stderr)
                 sys.exit(1)
 
-            if plugin_downloader_git["path"] in dict_local_dir:
-                err_str = ("more than one repository will be cloned " +
-                           "to the directory '" +
-                           str(plugin_downloader_git["path"]) + "' (" +
-                           str(git_repo_raw[BatchFetchCli.main_key]) + " and " +
-                           str(dict_local_dir[plugin_downloader_git["path"]]) +
+            dest_path = Path(batchfetch_instance["path"]).resolve()
+            if str(dest_path) in dict_local_dir:
+                err_str = ("More than one task have the " +
+                           f"destination path '{dest_path}' (" +
+                           str(task[keyword]) + " and " +
+                           str(dict_local_dir[(str(dest_path))]) +
                            ")")
                 raise BatchFetchError(err_str)
-            dict_local_dir[plugin_downloader_git["path"]] = \
-                plugin_downloader_git[BatchFetchCli.main_key]
 
-    def download(self) -> bool:
+            dict_local_dir[str(dest_path)] = batchfetch_instance[keyword]
+
+    def run_tasks(self) -> bool:
         failed = []
         error = False
         threads = []
@@ -136,13 +156,12 @@ class BatchFetchCli:
         try:
             self.dirs_relative_to_batchfetch = set()
 
-            # TODO: Make adding to all downloads automatic
-            all_downloads = self.cfg["tasks"]
-            for download_item in all_downloads:
-                self.dirs_relative_to_batchfetch.add(str(download_item["path"]))
-                if not download_item["delete"]:
-                    self.managed_filenames.add(download_item["path"])
-                threads.append(executor_update.submit(download_item.update))
+            all_tasks = self.cfg["tasks"]
+            for task in all_tasks:
+                self.dirs_relative_to_batchfetch.add(str(task["path"]))
+                if not task["delete"]:
+                    self.managed_filenames.add(task["path"])
+                threads.append(executor_update.submit(task.update))
 
             for future in as_completed(threads):
                 data = future.result()
@@ -174,29 +193,20 @@ class BatchFetchCli:
         if error:
             if failed:
                 print("Failed:")
-                for git_update_result in failed:
-                    print("  - url:", git_update_result[BatchFetchCli.main_key])
-                    print("    dir:", git_update_result["path"])
+                for failed_result in failed:
+                    print("  -", failed_result["path"])
             else:
                 print("Failed.")
 
             return False
         else:
             if num_success == 0:
-                print("Already up to date.")
+                print("Nothing to do.")
             elif not self.verbose:
                 print("Success.")
 
         return True
 
-    # def check_managed_directories(self):
-    #     # managed_downloads = {Path(item).resolve()
-    #     #                      for item in self.managed_filenames}
-    #     # managed_directories = {item.parent
-    #     #                        for item in managed_downloads}
-    #     # TODO Implement checker
-    #     pass
-
 
 def parse_args():
     """Parse the command line arguments."""
@@ -204,9 +214,13 @@ def parse_args():
     usage = "%(prog)s [--option] [args]"
     parser = argparse.ArgumentParser(description=desc, usage=usage)
 
+    parser.add_argument("batchfetch_files", metavar="N", type=str, nargs="*",
+                        help=("Specify the batchfetch YAML file(s) "
+                              "(default: './batchfetch.yaml')."))
+
     parser.add_argument(
         "-j", "--jobs", default="5", required=False,
-        help="Run up to N Number of parallel git processes (Default: 5).",
+        help="Run up to N Number of parallel processes (Default: 5).",
     )
 
     parser.add_argument(
@@ -214,43 +228,26 @@ def parse_args():
         help="Enable verbose mode.",
     )
 
-    parser.add_argument(
-        "-f",
-        "--batchfetch-file",
-        default="./batchfetch.yaml",
-        required=False,
-        help="Specify the batchfetch YAML file (default: './batchfetch.yaml').",
-    )
-
     args = parser.parse_args()
 
-    if not Path(args.batchfetch_file).is_file():
-        print(f"Error: File not found: {args.batchfetch_file}",
-              file=sys.stderr)
-        sys.exit(1)
+    for batchfetch_file in args.batchfetch_files:
+        if not Path(batchfetch_file).is_file():
+            print(f"Error: File not found: {batchfetch_file}",
+                  file=sys.stderr)
+            sys.exit(1)
 
     return args
 
 
-def command_line_interface():
-    """Command line interface."""
+def run_batchfetch_procedure(batchfetch_file: Path, args) -> int:
     errno = 0
-    logging.basicConfig(level=logging.INFO, stream=sys.stdout,
-                        format="%(asctime)s %(name)s: %(message)s")
-
-    colorama.init()
-    setproctitle(subprocess.list2cmdline([Path(sys.argv[0]).name] +
-                                         sys.argv[1:]))
-
-    args = parse_args()
-    downloader_cli = BatchFetchCli(verbose=args.verbose,
+    batchfetch_cli = BatchFetchCli(verbose=args.verbose,
                                    max_workers=int(args.jobs))
-
-    downloader_cli.load(args.batchfetch_file)
-    os.chdir(os.path.dirname(args.batchfetch_file))
+    batchfetch_cli.load(batchfetch_file)
+    os.chdir(batchfetch_file.parent)
 
     try:
-        if not downloader_cli.download():
+        if not batchfetch_cli.run_tasks():
             errno = 1
     except KeyboardInterrupt:
         print("Interrupted.", file=sys.stderr)
@@ -258,7 +255,32 @@ def command_line_interface():
     except BatchFetchError as err:
         print(f"Error: {err}.", file=sys.stderr)
         errno = 1
-    # else:
-    #     downloader_cli.check_managed_directories()
 
-    sys.exit(errno)
+    return errno
+
+
+def command_line_interface():
+    """Command line interface."""
+    try:
+        errno = 0
+        logging.basicConfig(level=logging.INFO, stream=sys.stdout,
+                            format="%(asctime)s %(name)s: %(message)s")
+
+        colorama.init()
+        setproctitle(subprocess.list2cmdline([Path(sys.argv[0]).name] +
+                                             sys.argv[1:]))
+
+        args = parse_args()
+        done = []
+        for batchfetch_file in args.batchfetch_files:
+            batchfetch_file = Path(batchfetch_file)
+            batchfetch_file_resolved = batchfetch_file.resolve()
+            if batchfetch_file_resolved in done:
+                continue
+
+            done.append(batchfetch_file_resolved)
+            errno |= run_batchfetch_procedure(batchfetch_file, args)
+
+        sys.exit(errno)
+    except BrokenPipeError:
+        pass

{batchfetch-1.0.4 → batchfetch-1.0.6}/batchfetch/batchfetch_git.py

@@ -10,7 +10,8 @@
 #
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
 #
 # You should have received a copy of the GNU General Public License along with
 # this program. If not, see <https://www.gnu.org/licenses/>.
@@ -27,25 +28,28 @@ from typing import List, Union
 
 from schema import Optional
 
-from .batchfetch_base import (BatchFetchBase, BatchFetchError,
-                              GitBranchDoesNotExist)
+from .batchfetch_base import BatchFetchBase, BatchFetchError
 from .helpers import run_simple
 
 
+class GitReferenceDoesNotExist(Exception):
+    """Exception raised by Name()."""
+
+
 class BatchFetchGit(BatchFetchBase):
     """Clone or update a Git repository."""
 
-    indent_spaces = " " * BatchFetchBase.indent
-    main_key = "git"
-
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
+        self.env["GIT_TERMINAL_PROMPT"] = "0"
+        self.indent_spaces = " " * self.indent
+        self.main_key = "git"
 
         # Schema
         self.item_schema.update({
             # Local options
-            BatchFetchGit.main_key: str,
-            Optional("branch"): str,
+            self.main_key: str,
+            Optional("reference"): str,
 
             # Same as global options
             Optional("clone_args"): [str],
@@ -63,8 +67,8 @@ class BatchFetchGit(BatchFetchBase):
                                            "git_pull": True})
 
         self.item_default_values.update({
-            BatchFetchGit.main_key: "",
-            "branch": "",
+            self.main_key: "",
+            "reference": "",
             "delete": False,
         })
 
@@ -75,16 +79,19 @@ class BatchFetchGit(BatchFetchBase):
     def _initialize_data(self):
         super()._initialize_data()
 
-        self.values[BatchFetchGit.main_key] = \
-            self.values[BatchFetchGit.main_key].rstrip("/")
+        self.values[self.main_key] = \
+            self.values[self.main_key].rstrip("/")
 
         if "path" not in self.values:
             self.values["path"] = \
                 posixpath.basename(
-                    self.values[BatchFetchGit.main_key])  # type: ignore
+                    self.values[self.main_key])  # type: ignore
 
     def _git_ref(self, cwd: Union[None, Path] = None) -> str:
-        """Get the commit reference of HEAD."""
+        """Get the commit reference of HEAD.
+
+        The command will fail if the branch is detached.
+        """
         cmd = "git show-ref --head --verify HEAD"
         try:
             stdout, _ = run_simple(cmd, cwd=cwd, env=self.env)
@@ -112,8 +119,8 @@ class BatchFetchGit(BatchFetchBase):
 
         self.add_output(
             f"[GIT {update_type}] {self[self.main_key]}" +
-            (f" (branch: {self['branch']})"
-             if self["branch"] else "") + "\n"
+            (f" (Reference: {self['reference']})"
+             if self["reference"] else "") + "\n"
         )
 
         try:
@@ -152,7 +159,7 @@ class BatchFetchGit(BatchFetchBase):
                             textwrap.indent(err.stderr, " " * self.indent))
 
         if not self.is_error() and not self.is_changed():
-            self.add_output(self.indent_spaces + "# Already up to date\n")
+            self.add_output(self.indent_spaces + "[INFO] Nothing to do.\n")
 
         return self.values
 
@@ -169,7 +176,7 @@ class BatchFetchGit(BatchFetchBase):
 
     def _repo_delete(self):
         if not self.git_local_dir.exists():
-            self.add_output(self.indent_spaces + "# Already deleted\n")
+            self.add_output(self.indent_spaces + "[INFO] Already deleted\n")
         elif not self.git_local_dir.joinpath(".git").is_dir():
             self.add_output(
                 self.indent_spaces +
@@ -180,7 +187,7 @@ class BatchFetchGit(BatchFetchBase):
         elif self.git_local_dir.is_dir():
             shutil.rmtree(str(self.git_local_dir))
             self.add_output(self.indent_spaces +
-                            f"# Deleted: '{self.git_local_dir}'")
+                            f"[INFO] Deleted: '{self.git_local_dir}'")
             self.set_changed(True)
 
     def _repo_clone(self):
@@ -188,7 +195,7 @@ class BatchFetchGit(BatchFetchBase):
         git_clone_args += ["--recurse-submodules"]
 
         cmd = ["git", "clone"] + git_clone_args + \
-            [self[BatchFetchGit.main_key], str(self.git_local_dir)]
+            [self[self.main_key], str(self.git_local_dir)]
         self._run(cmd, env=self.env)
         self.set_changed(True)
 
@@ -204,28 +211,37 @@ class BatchFetchGit(BatchFetchBase):
         ignore_git_pull = False
         if not self["git_pull"]:
             ignore_git_pull = True
-        elif self["branch"]:
+
+        if self["reference"]:
+            ignore_git_pull = False
             # Check if the new branch exists
             try:
-                self._git_tags(self["branch"])
-            except GitBranchDoesNotExist:
+                self._git_tags(self["reference"])
+            except GitReferenceDoesNotExist:
                 pass
             else:
-                # The branch exists
-
-                # Ignore Git pull when the git reference is the same
-                commit_ref = self._git_ref(cwd=self.git_local_dir)
-                if (self.current_branch and
-                    (commit_ref == self["branch"] or
-                     self.current_branch == self["branch"])):
-                    ignore_git_pull = True
-                # Ignore Git pull if it is not a local branch
-                elif not self._git_is_local_branch(self["branch"]):
+                # The branch exists:
+                # 1. Ignore Git pull when the git reference is the same
+                # as the "branch:" key
+                try:
+                    commit_ref = self._git_ref(cwd=self.git_local_dir)
+                except subprocess.CalledProcessError:
+                    # Ignore git pull because the head is detached
+                    pass
+                else:
+                    if (self.current_branch and
+                        (commit_ref == self["reference"] or
+                         self.current_branch == self["reference"])):
+                        ignore_git_pull = True
+
+                # 2. Ignore Git pull if it is not a local branch
+                if (not ignore_git_pull and
+                        not self._git_is_local_branch(self["reference"])):
                     ignore_git_pull = True
 
         if ignore_git_pull:
             self.add_output(self.indent_spaces +
-                            "# git pull ignored\n")
+                            "[INFO] git pull ignored\n")
         else:
             cmd = ["git", "fetch", "origin"]
             self._run(cmd, cwd=str(self.git_local_dir), env=self.env)
@@ -272,15 +288,15 @@ class BatchFetchGit(BatchFetchBase):
                 env=self.env,
                 cwd=self.git_local_dir)
         except subprocess.CalledProcessError as err:
-            raise GitBranchDoesNotExist(
-                f"The branch '{branch}' does not exist.") from err
+            raise GitReferenceDoesNotExist(
+                f"The reference '{branch}' does not exist.") from err
 
         return stdout
 
     def _repo_fix_branch(self) -> bool:
         git_ref_after_merge = self._git_ref(cwd=self.git_local_dir)
         branch_changed = False
-        if self["branch"]:
+        if self["reference"]:
             # We also need tags because sometimes, a branch
             # returns a different commit reference
             git_tags, _ = run_simple(
@@ -292,18 +308,19 @@ class BatchFetchGit(BatchFetchBase):
             # Also check the commit reference in case
             # branch is a commit reference instead of a tag
             try:
-                git_ref_branch = self._git_tags(self["branch"])[0]
-            except GitBranchDoesNotExist as err:
+                git_ref_branch = self._git_tags(self["reference"])[0]
+            except GitReferenceDoesNotExist as err:
                 raise BatchFetchError(f"The branch '{self['branch']}' "
                                       "does not exist.") from err
 
             if git_ref_after_merge != git_ref_branch and \
-                    self["branch"] not in git_tags:
+                    self["reference"] not in git_tags:
                 # Update the branch
-                self._run(["git", "checkout"] + [self["branch"]],
+                self._run(["git", "checkout"] + [self["reference"]],
                           cwd=str(self.git_local_dir), env=self.env)
-                self.add_output(self.indent_spaces + "# Branch changed to " +
-                                self["branch"] + "\n")
+                self.add_output(self.indent_spaces +
+                                "[INFO] Branch changed to " +
+                                self["reference"] + "\n")
                 self.set_changed(True)
                 branch_changed = True
 
@@ -339,7 +356,7 @@ class BatchFetchGit(BatchFetchBase):
         except IndexError:
             origin_url = ""
 
-        if origin_url != self[BatchFetchGit.main_key]:
+        if origin_url != self[self.main_key]:
             self.set_error(True)
             self.add_output(
                 self.indent_spaces +

{batchfetch-1.0.4 → batchfetch-1.0.6}/batchfetch/helpers.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 #
 # Copyright (c) James Cherti
 # URL: https://github.com/jamescherti/batchfetch
@@ -9,7 +10,8 @@
 #
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
 #
 # You should have received a copy of the GNU General Public License along with
 # this program. If not, see <https://www.gnu.org/licenses/>.
@@ -28,7 +30,7 @@ def md5sum(filename: os.PathLike):
     Calculate and return the MD5 checksum of a file.
 
     Args:
-        filename: The path to the file for which the MD5 checksum is calculated.
+        filename: Path to the file for which the MD5 checksum is calculated.
 
     Returns:
         str: The MD5 checksum of the file.

{batchfetch-1.0.4 → batchfetch-1.0.6/batchfetch.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.0.4
+Version: 1.0.6
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -17,10 +17,6 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.6, <4
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: colorama
-Requires-Dist: schema
-Requires-Dist: setproctitle
-Requires-Dist: PyYAML
 
 # Batchfetch - Efficiently clone or pull multiple Git repositories in parallel
 
@@ -61,12 +57,12 @@ tasks:
   # Clone the tag 1.5 of the consult repository to the './consult'
   # directory
   - git: https://github.com/minad/consult
-    branch: "1.5"
+    reference: "1.5"
 
   # Clone the s.el repository to the './another-name.el' directory
   - git: https://github.com/magnars/s.el
     path: another-name.el
-    branch: dda84d38fffdaf0c9b12837b504b402af910d01d
+    reference: dda84d38fffdaf0c9b12837b504b402af910d01d
 
   # Delete './impatient-mode'
   - git: https://github.com/skeeto/impatient-mode
@@ -84,14 +80,15 @@ usage: batchfetch [--option] [args]
 
 Command line interface.
 
+positional arguments:
+  N                     Specify the batchfetch YAML file(s) (default: './batchfetch.yaml').
+
 options:
   -h, --help            show this help message and exit
-  -j JOBS, --jobs JOBS
-                        Run up to N Number of parallel git processes (Default: 5).
+  -j JOBS, --jobs JOBS  Run up to N Number of parallel processes (Default: 5).
   -v, --verbose         Enable verbose mode.
-  -f BATCHFETCH_FILE, --batchfetch-file BATCHFETCH_FILE
-                        Specify the batchfetch YAML file (default: './batchfetch.yaml').
 ```
+
 ## License
 
 Copyright (c) [James Cherti](https://www.jamescherti.com)

{batchfetch-1.0.4 → batchfetch-1.0.6}/batchfetch.egg-info/SOURCES.txt

@@ -1,7 +1,5 @@
-.gitignore
 LICENSE
 README.md
-run_tests.sh
 setup.py
 batchfetch/__init__.py
 batchfetch/batchfetch_base.py
@@ -13,7 +11,4 @@ batchfetch.egg-info/SOURCES.txt
 batchfetch.egg-info/dependency_links.txt
 batchfetch.egg-info/entry_points.txt
 batchfetch.egg-info/requires.txt
-batchfetch.egg-info/top_level.txt
-tests/test_helpers.py
-tests/data/test-md5sum.txt
-tests/data/test-run_simple.sh
+batchfetch.egg-info/top_level.txt

batchfetch-1.0.6/batchfetch.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+batchfetch = batchfetch.batchfetch_cli:command_line_interface

{batchfetch-1.0.4 → batchfetch-1.0.6}/setup.py

@@ -22,7 +22,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="batchfetch",
-    version="1.0.4",
+    version="1.0.6",
     packages=find_packages(),
     description="Efficiently clone and pull multiple Git repositories.",
     license="GPLv3",
@@ -51,7 +51,7 @@ setup(
     ],
     entry_points={
         "console_scripts": [
-            "batchfetch=batchfetch.__init__:command_line_interface",
+            "batchfetch=batchfetch.batchfetch_cli:command_line_interface",
         ],
     },
 )

batchfetch-1.0.4/.gitignore

@@ -1,138 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$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
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.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/

batchfetch-1.0.4/batchfetch.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-batchfetch = batchfetch.__init__:command_line_interface

batchfetch-1.0.4/run_tests.sh

@@ -1,23 +0,0 @@
-#!/usr/bin/env bash
-#
-# Copyright (c) James Cherti
-# URL: https://github.com/jamescherti/batchfetch
-#
-# This program is free software: you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation, either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program. If not, see <https://www.gnu.org/licenses/>.
-#
-cd "$(dirname "${BASH_SOURCE[0]}")"
-export PYTHONPATH="$(pwd)"
-exec pytest -v -v --cov=batchfetch --cov=tests \
-  --cov-report=term \
-  --cov-report=html:htmlcov \
-  tests/test_*py

batchfetch-1.0.4/tests/data/test-md5sum.txt

@@ -1,3 +0,0 @@
-Test 1.
-Test 2.
-Test 3.

batchfetch-1.0.4/tests/data/test-run_simple.sh

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-cd "$(dirname "${BASH_SOURCE[0]}")"
-cat ./test-md5sum.txt
-cat ./test-md5sum.txt | tail -n 1 >&2

batchfetch-1.0.4/tests/test_helpers.py

@@ -1,56 +0,0 @@
-#!/usr/bin/env python
-#
-# Copyright (c) James Cherti
-# URL: https://github.com/jamescherti/batchfetch
-#
-# This program is free software: you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation, either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program. If not, see <https://www.gnu.org/licenses/>.
-#
-"""Unit tests."""
-
-from pathlib import Path
-
-from batchfetch import helpers
-
-DATA_PATH = Path(".").joinpath("tests", "data").absolute()
-SCRIPT_RUN_SIMPLE = DATA_PATH / "test-run_simple.sh"
-TEST_MD5SUM_FILE = DATA_PATH / "test-md5sum.txt"
-
-
-def test_md5sum():
-    md5sum = helpers.md5sum(TEST_MD5SUM_FILE)
-    assert md5sum == "f31e127edc87a6aa2eb01b7d94d2ec58"
-
-
-def test_run_simple():
-    # Stdout
-    stdout_lines, stderr_lines = helpers.run_simple(str(SCRIPT_RUN_SIMPLE))
-    assert stdout_lines == ['Test 1.',
-                            'Test 2.',
-                            'Test 3.']
-    assert stderr_lines == ['Test 3.']
-
-
-def test_indent_raw_output():
-    list_str = \
-        helpers.indent_raw_output(["Test 1.", "Test 2."])
-
-    assert list_str == ["    Test 1.", "    Test 2."]
-
-
-def test_run_indent():
-    stdout_lines, stderr_lines = helpers.run_indent(str(SCRIPT_RUN_SIMPLE))
-    assert stdout_lines == [f'    [RUN] {str(SCRIPT_RUN_SIMPLE)}',
-                            '    Test 1.',
-                            '    Test 2.',
-                            '    Test 3.']
-    assert stderr_lines == ['    Test 3.']

{batchfetch-1.0.4 → batchfetch-1.0.6}/batchfetch.egg-info/requires.txt

@@ -1,4 +1,4 @@
+PyYAML
 colorama
 schema
 setproctitle
-PyYAML