Merge branch 'develop' (release/0.5)

Author: earwig

CHANGELOG

@@ -1,3 +1,18 @@
+v0.5 (released August 28, 2018):
+
+- Added a `--depth` flag to control recursion depth when searching for
+  repositories inside of subdirectories. For example:
+  - `--depth 0` will never recurse into subdirectories; the provided paths must
+    be repositories by themselves.
+  - `--depth 1` will descend one level to look for repositories. This is the
+    old behavior.
+  - `--depth 3` will look three levels deep. This is the new default.
+  - `--depth -1` will recurse indefinitely. This is not recommended.
+- Allow gitup to be run directly as a Python module (python -m gitup).
+- Fixed an error when updating branches if the upstream is completely unrelated
+  from the local branch (no common ancestor).
+- Fixed error message when fetching from a remote fails.
+
 v0.4.1 (released December 13, 2017):
 
 - Bump dependencies to deal with newer versions of Git.
@@ -13,7 +28,7 @@ v0.4 (released January 17, 2017):
 - Cleaned up the bookmark file format, fixing a related Windows bug. The script
   will automatically migrate to the new one.
 - Fixed a bug related to Python 3 compatibility.
-- Fixed unicode support.
+- Fixed Unicode support.
 
 v0.3 (released June 7, 2015):
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2011-2017 Ben Kurtovic <[email protected]>
+Copyright (C) 2011-2018 Ben Kurtovic <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,9 @@
 __gitup__ (the _git-repo-updater_)
 
-gitup is a tool designed to update a large number of git repositories at once.
-It is smart enough to handle multiple remotes, branches, dirty working
-directories, and more, hopefully providing a great way to get everything
-up-to-date for short periods of internet access between long periods of none.
+gitup is a tool for updating multiple git repositories at once. It is smart
+enough to handle several remotes, dirty working directories, diverged local
+branches, detached HEADs, and more. It was originally created to manage a large
+collection of projects and deal with sporadic internet access.
 
 gitup should work on OS X, Linux, and Windows. You should have the latest
 version of git and either Python 2.7 or Python 3 installed.
@@ -25,7 +25,7 @@ Then, to install for everyone:
 
     sudo python setup.py install
 
-...or for just yourself (make sure you have `~/.local/bin` in your PATH):
+or for just yourself (make sure you have `~/.local/bin` in your PATH):
 
     python setup.py install --user
 
@@ -53,7 +53,7 @@ Additionally, you can just type:
 
 to automatically update all git repositories in that directory.
 
-To add a bookmark (or bookmarks), either of these will work:
+To add bookmarks, either of these will work:
 
     gitup --add ~/repos/foo ~/repos/bar ~/repos/baz
     gitup --add ~/repos
@@ -81,21 +81,25 @@ Update all git repositories in your current directory:
 
     gitup .
 
+You can control how deep gitup will look for repositories in a given directory,
+if that directory is not a git repo by itself, with the `--depth` (or `-t`)
+option. `--depth 0` will disable recursion entirely, meaning the provided paths
+must be repos by themselves. `--depth 1` will descend one level (this is the
+old behavior from pre-0.5 gitup). `--depth -1` will recurse indefinitely,
+which is not recommended. The default is `--depth 3`.
+
 By default, gitup will fetch all remotes in a repository. Pass `--current-only`
-(or `-c`) to make it fetch _only_ the remote tracked by the current branch.
+(or `-c`) to make it fetch only the remote tracked by the current branch.
 
 Also by default, gitup will try to fast-forward all branches that have
 upstreams configured. It will always skip branches where this is not possible
 (e.g. dirty working directory or a merge/rebase is required). Pass
-`--fetch-only` (or `-f`) to only fetch remotes.
+`--fetch-only` (or `-f`) to skip this step and only fetch remotes.
 
 After fetching, gitup will _keep_ remote-tracking branches that no longer exist
 upstream. Pass `--prune` (or `-p`) to delete them, or set `fetch.prune` or
-`remote.<name>.prune` in git config to do this by default.
+`remote.<name>.prune` in your git config to do this by default.
 
 For a full list of all command arguments and abbreviations:
 
     gitup --help
-
-Finally, all paths can be either absolute (e.g. `/path/to/repo`) or relative
-(e.g. `../my/repo`).

gitup/__init__.py

@@ -1,14 +1,14 @@
 # -*- coding: utf-8  -*-
 #
-# Copyright (C) 2011-2017 Ben Kurtovic <[email protected]>
+# Copyright (C) 2011-2018 Ben Kurtovic <[email protected]>
 # Released under the terms of the MIT License. See LICENSE for details.
 
 """
 gitup: the git repository updater
 """
 
 __author__ = "Ben Kurtovic"
-__copyright__ = "Copyright (C) 2011-2017 Ben Kurtovic"
+__copyright__ = "Copyright (C) 2011-2018 Ben Kurtovic"
 __license__ = "MIT License"
-__version__ = "0.4.1"
+__version__ = "0.5"
 __email__ = "[email protected]"

gitup/__main__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8  -*-
+#
+# Copyright (C) 2011-2018 Ben Kurtovic <[email protected]>
+# Released under the terms of the MIT License. See LICENSE for details.
+
+from .script import run
+
+if __name__ == "__main__":
+    run()

gitup/script.py

@@ -1,12 +1,13 @@
 # -*- coding: utf-8  -*-
 #
-# Copyright (C) 2011-2016 Ben Kurtovic <[email protected]>
+# Copyright (C) 2011-2018 Ben Kurtovic <[email protected]>
 # Released under the terms of the MIT License. See LICENSE for details.
 
 from __future__ import print_function
 
 import argparse
 import os
+import platform
 import sys
 
 from colorama import init as color_init, Fore, Style
@@ -39,11 +40,15 @@ def main():
 
     group_u.add_argument(
         'directories_to_update', nargs="*", metavar="path", type=_decode,
-        help="""update all repositories in this directory (or the directory
-                itself, if it is a repo)""")
+        help="""update this repository, or all repositories it contains
+        (if not a repo directly)""")
     group_u.add_argument(
         '-u', '--update', action="store_true", help="""update all bookmarks
         (default behavior when called without arguments)""")
+    group_u.add_argument(
+        '-t', '--depth', dest="max_depth", metavar="n", type=int, default=3,
+        help="""max recursion depth when searching for repos in subdirectories
+        (default: 3; use 0 for no recursion, or -1 for unlimited)""")
     group_u.add_argument(
         '-c', '--current-only', action="store_true", help="""only fetch the
         remote tracked by the current branch instead of all remotes""")
@@ -80,7 +85,8 @@ def main():
         '-h', '--help', action="help", help="show this help message and exit")
     group_m.add_argument(
         '-v', '--version', action="version",
-        version="gitup " + __version__)
+        version="gitup {0} (Python {1})".format(
+            __version__, platform.python_version()))
 
     # TODO: deprecated arguments, for removal in v1.0:
     parser.add_argument(
@@ -90,7 +96,6 @@ def main():
 
     color_init(autoreset=True)
     args = parser.parse_args()
-    update_args = args.current_only, args.fetch_only, args.prune
 
     print(Style.BRIGHT + "gitup" + Style.RESET_ALL + ": the git-repo-updater")
     print()
@@ -121,15 +126,15 @@ def main():
 
     if args.command:
         if args.directories_to_update:
-            run_command(args.directories_to_update, args.command)
+            run_command(args.directories_to_update, args)
         if args.update or not args.directories_to_update:
-            run_command(get_bookmarks(args.bookmark_file), args.command)
+            run_command(get_bookmarks(args.bookmark_file), args)
     else:
         if args.directories_to_update:
-            update_directories(args.directories_to_update, update_args)
+            update_directories(args.directories_to_update, args)
             acted = True
         if args.update or not acted:
-            update_bookmarks(get_bookmarks(args.bookmark_file), update_args)
+            update_bookmarks(get_bookmarks(args.bookmark_file), args)
 
 def run():
     """Thin wrapper for main() that catches KeyboardInterrupts."""