batchfetch 1.0.1__tar.gz → 1.0.3__tar.gz

{batchfetch-1.0.1/batchfetch.egg-info → batchfetch-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.0.1
+Version: 1.0.3
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -22,18 +22,30 @@ Requires-Dist: schema
 Requires-Dist: setproctitle
 Requires-Dist: PyYAML
 
-# Batchfetch - Efficiently clone or pull multiple Git repositories.
+# Batchfetch - Efficiently clone or pull multiple Git repositories in parallel
 
 ## Introduction
 
-Efficiently clone or pull multiple Git repositories in parallel. Ideal for developers managing multiple projects or for downloading plugins or packages in bulk.
+Batchfetch is a command-line tool designed to clone, fetch, and merge multiple Git repositories simultaneously.
+
+With Batchfetch, you no longer need to manually manage each repository one by one. It automates the tedious aspects of repository management, freeing you up to focus on what truly matters: your workflow.
+
+Batchfetch is ideal for quickly cloning or pulling multiple Git repositories. It is also useful for cloning various addons, such as Vim plugins, Emacs packages, Ansible roles, Ansible collections, and other addons available on websites like GitHub, Codeberg, and GitLab.
+
+## Features:
+- Git Clone and Fetch/Merge: Clones the repositories and their submodules, ensuring that all the repositories are always up-to-date by fetching and merging changes.
+- Parallel Operations: Utilizes threads to simultaneously Git clone or pull multiple repositories, dramatically reducing wait times.
+- User-Friendly Interface: Provides simple and straightforward command-line options that make it easy to get started and effectively manage your repositories.
+- Custom Configuration: Allows the use of a YAML configuration file to specify and manage the repositories you interact with, enabling repeatable setups and consistent environments.
 
 ## Installation
 
 ```
-sudo pip install git+https://github.com/jamescherti/batchfetch
+pip install --user batchfetch
 ```
 
+The pip command above will install the `batchfetch` executable in the directory `~/.local/bin/`.
+
 ## Example
 
 Here is an example of a `batchfetch.yaml` file:
@@ -63,6 +75,23 @@ tasks:
 
 Execute the `batchfetch` command from the same directory as `batchfetch.yml` to make it clone or update the local copies of the repositories above.
 
+## Usage
+
+Here are the various options that `batchfetch` provides, along with descriptions of their usage:
+
+```
+usage: batchfetch [--option] [args]
+
+Command line interface.
+
+options:
+  -h, --help            show this help message and exit
+  -j JOBS, --jobs JOBS
+                        Run up to N Number of parallel git 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)
@@ -75,4 +104,5 @@ You should have received a copy of the GNU General Public License along with thi
 
 ## Links
 
-- [The batchfetch Git repository](https://github.com/jamescherti/batchfetch)
+- [batchfetch @GitHub](https://github.com/jamescherti/batchfetch)
+- [batchfetch @Pypi](https://pypi.org/project/batchfetch/)

batchfetch-1.0.3/README.md

@@ -0,0 +1,84 @@
+# Batchfetch - Efficiently clone or pull multiple Git repositories in parallel
+
+## Introduction
+
+Batchfetch is a command-line tool designed to clone, fetch, and merge multiple Git repositories simultaneously.
+
+With Batchfetch, you no longer need to manually manage each repository one by one. It automates the tedious aspects of repository management, freeing you up to focus on what truly matters: your workflow.
+
+Batchfetch is ideal for quickly cloning or pulling multiple Git repositories. It is also useful for cloning various addons, such as Vim plugins, Emacs packages, Ansible roles, Ansible collections, and other addons available on websites like GitHub, Codeberg, and GitLab.
+
+## Features:
+- Git Clone and Fetch/Merge: Clones the repositories and their submodules, ensuring that all the repositories are always up-to-date by fetching and merging changes.
+- Parallel Operations: Utilizes threads to simultaneously Git clone or pull multiple repositories, dramatically reducing wait times.
+- User-Friendly Interface: Provides simple and straightforward command-line options that make it easy to get started and effectively manage your repositories.
+- Custom Configuration: Allows the use of a YAML configuration file to specify and manage the repositories you interact with, enabling repeatable setups and consistent environments.
+
+## Installation
+
+```
+pip install --user batchfetch
+```
+
+The pip command above will install the `batchfetch` executable in the directory `~/.local/bin/`.
+
+## Example
+
+Here is an example of a `batchfetch.yaml` file:
+
+```yaml
+---
+
+tasks:
+  # Clone the default branch of the general.el repository to the
+  # './general.el' directory
+  - git: https://github.com/noctuid/general.el
+
+  # Clone the tag 1.5 of the consult repository to the './consult'
+  # directory
+  - git: https://github.com/minad/consult
+    branch: "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
+
+  # Delete './impatient-mode'
+  - git: https://github.com/skeeto/impatient-mode
+    delete: true
+```
+
+Execute the `batchfetch` command from the same directory as `batchfetch.yml` to make it clone or update the local copies of the repositories above.
+
+## Usage
+
+Here are the various options that `batchfetch` provides, along with descriptions of their usage:
+
+```
+usage: batchfetch [--option] [args]
+
+Command line interface.
+
+options:
+  -h, --help            show this help message and exit
+  -j JOBS, --jobs JOBS
+                        Run up to N Number of parallel git 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)
+
+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.
+
+## Links
+
+- [batchfetch @GitHub](https://github.com/jamescherti/batchfetch)
+- [batchfetch @Pypi](https://pypi.org/project/batchfetch/)

{batchfetch-1.0.1 → batchfetch-1.0.3}/batchfetch/batchfetch_cli.py

@@ -19,6 +19,7 @@
 
 import argparse
 import logging
+import os
 import subprocess
 import sys
 from concurrent.futures import ThreadPoolExecutor, as_completed
@@ -183,7 +184,7 @@ class BatchFetchCli:
         else:
             if num_success == 0:
                 print("Already up to date.")
-            else:
+            elif not self.verbose:
                 print("Success.")
 
         return True
@@ -201,19 +202,33 @@ def parse_args():
     """Parse the command line arguments."""
     desc = __doc__
     usage = "%(prog)s [--option] [args]"
-    parser = argparse.ArgumentParser(description=desc,
-                                     usage=usage)
+    parser = argparse.ArgumentParser(description=desc, usage=usage)
+
     parser.add_argument(
-        "-p", "--max-procs", default="3", required=False,
-        help="Run up to N Number of parallel git fetch processes.",
+        "-j", "--jobs", default="5", required=False,
+        help="Run up to N Number of parallel git processes (Default: 5).",
     )
 
     parser.add_argument(
         "-v", "--verbose", action="store_true", default=False,
-        help="Verbose mode.",
+        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)
+
     return args
 
 
@@ -224,16 +239,16 @@ def command_line_interface():
                         format="%(asctime)s %(name)s: %(message)s")
 
     colorama.init()
-    setproctitle(subprocess.list2cmdline(
-        [Path(sys.argv[0]).name] + sys.argv[1:]
-    ))
+    setproctitle(subprocess.list2cmdline([Path(sys.argv[0]).name] +
+                                         sys.argv[1:]))
 
     args = parse_args()
-
-    path_batchfetch_yaml = "batchfetch.yaml"
     downloader_cli = BatchFetchCli(verbose=args.verbose,
-                                   max_workers=int(args.max_procs))
-    downloader_cli.load(path_batchfetch_yaml)
+                                   max_workers=int(args.jobs))
+
+    downloader_cli.load(args.batchfetch_file)
+    os.chdir(os.path.dirname(args.batchfetch_file))
+
     try:
         if not downloader_cli.download():
             errno = 1

{batchfetch-1.0.1 → batchfetch-1.0.3/batchfetch.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.0.1
+Version: 1.0.3
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -22,18 +22,30 @@ Requires-Dist: schema
 Requires-Dist: setproctitle
 Requires-Dist: PyYAML
 
-# Batchfetch - Efficiently clone or pull multiple Git repositories.
+# Batchfetch - Efficiently clone or pull multiple Git repositories in parallel
 
 ## Introduction
 
-Efficiently clone or pull multiple Git repositories in parallel. Ideal for developers managing multiple projects or for downloading plugins or packages in bulk.
+Batchfetch is a command-line tool designed to clone, fetch, and merge multiple Git repositories simultaneously.
+
+With Batchfetch, you no longer need to manually manage each repository one by one. It automates the tedious aspects of repository management, freeing you up to focus on what truly matters: your workflow.
+
+Batchfetch is ideal for quickly cloning or pulling multiple Git repositories. It is also useful for cloning various addons, such as Vim plugins, Emacs packages, Ansible roles, Ansible collections, and other addons available on websites like GitHub, Codeberg, and GitLab.
+
+## Features:
+- Git Clone and Fetch/Merge: Clones the repositories and their submodules, ensuring that all the repositories are always up-to-date by fetching and merging changes.
+- Parallel Operations: Utilizes threads to simultaneously Git clone or pull multiple repositories, dramatically reducing wait times.
+- User-Friendly Interface: Provides simple and straightforward command-line options that make it easy to get started and effectively manage your repositories.
+- Custom Configuration: Allows the use of a YAML configuration file to specify and manage the repositories you interact with, enabling repeatable setups and consistent environments.
 
 ## Installation
 
 ```
-sudo pip install git+https://github.com/jamescherti/batchfetch
+pip install --user batchfetch
 ```
 
+The pip command above will install the `batchfetch` executable in the directory `~/.local/bin/`.
+
 ## Example
 
 Here is an example of a `batchfetch.yaml` file:
@@ -63,6 +75,23 @@ tasks:
 
 Execute the `batchfetch` command from the same directory as `batchfetch.yml` to make it clone or update the local copies of the repositories above.
 
+## Usage
+
+Here are the various options that `batchfetch` provides, along with descriptions of their usage:
+
+```
+usage: batchfetch [--option] [args]
+
+Command line interface.
+
+options:
+  -h, --help            show this help message and exit
+  -j JOBS, --jobs JOBS
+                        Run up to N Number of parallel git 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)
@@ -75,4 +104,5 @@ You should have received a copy of the GNU General Public License along with thi
 
 ## Links
 
-- [The batchfetch Git repository](https://github.com/jamescherti/batchfetch)
+- [batchfetch @GitHub](https://github.com/jamescherti/batchfetch)
+- [batchfetch @Pypi](https://pypi.org/project/batchfetch/)

{batchfetch-1.0.1 → batchfetch-1.0.3}/setup.py

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

batchfetch-1.0.1/README.md

@@ -1,54 +0,0 @@
-# Batchfetch - Efficiently clone or pull multiple Git repositories.
-
-## Introduction
-
-Efficiently clone or pull multiple Git repositories in parallel. Ideal for developers managing multiple projects or for downloading plugins or packages in bulk.
-
-## Installation
-
-```
-sudo pip install git+https://github.com/jamescherti/batchfetch
-```
-
-## Example
-
-Here is an example of a `batchfetch.yaml` file:
-
-```yaml
----
-
-tasks:
-  # Clone the default branch of the general.el repository to the
-  # './general.el' directory
-  - git: https://github.com/noctuid/general.el
-
-  # Clone the tag 1.5 of the consult repository to the './consult'
-  # directory
-  - git: https://github.com/minad/consult
-    branch: "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
-
-  # Delete './impatient-mode'
-  - git: https://github.com/skeeto/impatient-mode
-    delete: true
-```
-
-Execute the `batchfetch` command from the same directory as `batchfetch.yml` to make it clone or update the local copies of the repositories above.
-
-## License
-
-Copyright (c) [James Cherti](https://www.jamescherti.com)
-
-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.
-
-## Links
-
-- [The batchfetch Git repository](https://github.com/jamescherti/batchfetch)