gitlabber 1.2.1__tar.gz → 1.2.2__tar.gz

{gitlabber-1.2.1/gitlabber.egg-info → gitlabber-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlabber
-Version: 1.2.1
+Version: 1.2.2
 Summary: A Gitlab clone/pull utility for backing up or cloning Gitlab groups
 Home-page: https://github.com/ezbz/gitlabber
 Download-URL: https://github.com/ezbz/gitlabber/archive/master.zip
@@ -23,6 +23,13 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: docopt
+Requires-Dist: anytree
+Requires-Dist: globre
+Requires-Dist: pyyaml
+Requires-Dist: tqdm
+Requires-Dist: GitPython
+Requires-Dist: python-gitlab
 
 .. image:: https://github.com/ezbz/gitlabber/actions/workflows/python-app.yml/badge.svg?branch=master
     :target: https://github.com/ezbz/gitlabber/actions/workflows/python-app.yml
@@ -42,6 +49,7 @@ License-File: LICENSE.txt
 .. image:: https://readthedocs.org/projects/gitlabber/badge/?version=latest&style=plastic
     :target: https://gitlabber.readthedocs.io/en/latest/README.html
 
+
 Gitlabber
 =========
 
@@ -111,62 +119,61 @@ Usage
 
 .. code-block:: bash
 
-    usage: gitlabber [-h] [-t token] [-u url] [--verbose] [-p] [-d]
-                    [--print-format {json,yaml,tree}] [-m {ssh,https}] [-i csv]
-                    [-x csv] [--version] [-g {id,full_path,full_name}]
-                    [dest]
-
-    Gitlabber - clones or pulls entire groups/projects tree from GitLab
+ usage: gitlabber [-h] [-t token] [-T] [-u url] [--verbose] [-p] [--print-format {json,yaml,tree}] [-n {name,path}] [-m {ssh,http}] [-a {include,exclude,only}] [-i csv] [-x csv] [-r] [-F] [-d] [-s] [--version]
+                 [dest]
 
+    Gitlabber - clones or pulls entire groups/projects tree from gitlab
+    
     positional arguments:
-    dest                  destination path for the cloned tree (created if doesn't exist)
-
-    optional arguments:
-    -h, --help            show this help message and exit
-    -t token, --token token
+      dest                  destination path for the cloned tree (created if doesn't exist)
+    
+    options:
+      -h, --help            show this help message and exit
+      -t token, --token token
                             gitlab personal access token https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
-    -u url, --url url     base gitlab url (e.g.: 'http://gitlab.mycompany.com')
-    --verbose             print more verbose output
-    -p, --print           print the tree without cloning
-    --print-format {json,yaml,tree}
+      -T, --hide-token      use an inline URL token (avoids storing the gitlab personal access token in the .git/config)
+      -u url, --url url     base gitlab url (e.g.: 'http://gitlab.mycompany.com')
+      --verbose             print more verbose output
+      -p, --print           print the tree without cloning
+      --print-format {json,yaml,tree}
                             print format (default: 'tree')
-    -n {name,path}, --naming {name,path}
-                            the folder naming strategy for projects (default: "name")
-    -m {ssh,http}, --method {ssh,http}
+      -n {name,path}, --naming {name,path}
+                            the folder naming strategy for projects from the gitlab API attributes (default: "name")
+      -m {ssh,http}, --method {ssh,http}
                             the git transport method to use for cloning (default: "ssh")
-    -a {include,exclude,only}, --archived {include,exclude,only}
+      -a {include,exclude,only}, --archived {include,exclude,only}
                             include archived projects and groups in the results (default: "include")
-    -i csv, --include csv
+      -i csv, --include csv
                             comma delimited list of glob patterns of paths to projects or groups to clone/pull
-    -x csv, --exclude csv
+      -x csv, --exclude csv
                             comma delimited list of glob patterns of paths to projects or groups to exclude from clone/pull
-    -r, --recursive       clone/pull git submodules recursively
-    -T, --hide-token      hide the token from the gitlab request URL (for method: http)
-    -f, --use-fetch       clone/fetch git repository (mirrored repositories)
-    -s, --include-shared  include shared projects in the results
-    --version             print the version
-
+      -r, --recursive       clone/pull git submodules recursively
+      -F, --use-fetch       clone/fetch git repository (mirrored repositories)
+      -d, --dont-checkout   don't checkout pulled git repository
+      -s, --include-shared  include shared projects in the results
+      --version             print the version
+    
     examples:
-
-        clone an entire gitlab tree using a base url and a token:
-        gitlabber -t <personal access token> -u <gitlab url> .
-
-        # the following examples assume you provided token/url in environment variables so these arguments are omitted
+    
+        clone an entire gitlab tree using a url and a token:
+        gitlabber -t <personal access token> -u <gitlab url>
+    
         only print the gitlab tree:
         gitlabber -p .
-
+    
         clone only projects under subgroup 'MySubGroup' to location '~/GitlabRoot':
         gitlabber -i '/MyGroup/MySubGroup**' ~/GitlabRoot
-
+    
         clone only projects under group 'MyGroup' excluding any projects under subgroup 'MySubGroup':
         gitlabber -i '/MyGroup**' -x '/MyGroup/MySubGroup**' .
-
+    
         clone an entire gitlab tree except projects under groups named 'ArchiveGroup':
         gitlabber -x '/ArchiveGroup**' .
-
+    
         clone projects that start with a case insensitive 'w' using a regular expression:
         gitlabber -i '/{[w].*}' .
 
+
 Debugging
 ---------
 * You can use the `--verbose` flag to print Gitlabber debug messages

{gitlabber-1.2.1 → gitlabber-1.2.2}/README.rst

@@ -16,6 +16,7 @@
 .. image:: https://readthedocs.org/projects/gitlabber/badge/?version=latest&style=plastic
     :target: https://gitlabber.readthedocs.io/en/latest/README.html
 
+
 Gitlabber
 =========
 
@@ -85,62 +86,61 @@ Usage
 
 .. code-block:: bash
 
-    usage: gitlabber [-h] [-t token] [-u url] [--verbose] [-p] [-d]
-                    [--print-format {json,yaml,tree}] [-m {ssh,https}] [-i csv]
-                    [-x csv] [--version] [-g {id,full_path,full_name}]
-                    [dest]
-
-    Gitlabber - clones or pulls entire groups/projects tree from GitLab
+ usage: gitlabber [-h] [-t token] [-T] [-u url] [--verbose] [-p] [--print-format {json,yaml,tree}] [-n {name,path}] [-m {ssh,http}] [-a {include,exclude,only}] [-i csv] [-x csv] [-r] [-F] [-d] [-s] [--version]
+                 [dest]
 
+    Gitlabber - clones or pulls entire groups/projects tree from gitlab
+    
     positional arguments:
-    dest                  destination path for the cloned tree (created if doesn't exist)
-
-    optional arguments:
-    -h, --help            show this help message and exit
-    -t token, --token token
+      dest                  destination path for the cloned tree (created if doesn't exist)
+    
+    options:
+      -h, --help            show this help message and exit
+      -t token, --token token
                             gitlab personal access token https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
-    -u url, --url url     base gitlab url (e.g.: 'http://gitlab.mycompany.com')
-    --verbose             print more verbose output
-    -p, --print           print the tree without cloning
-    --print-format {json,yaml,tree}
+      -T, --hide-token      use an inline URL token (avoids storing the gitlab personal access token in the .git/config)
+      -u url, --url url     base gitlab url (e.g.: 'http://gitlab.mycompany.com')
+      --verbose             print more verbose output
+      -p, --print           print the tree without cloning
+      --print-format {json,yaml,tree}
                             print format (default: 'tree')
-    -n {name,path}, --naming {name,path}
-                            the folder naming strategy for projects (default: "name")
-    -m {ssh,http}, --method {ssh,http}
+      -n {name,path}, --naming {name,path}
+                            the folder naming strategy for projects from the gitlab API attributes (default: "name")
+      -m {ssh,http}, --method {ssh,http}
                             the git transport method to use for cloning (default: "ssh")
-    -a {include,exclude,only}, --archived {include,exclude,only}
+      -a {include,exclude,only}, --archived {include,exclude,only}
                             include archived projects and groups in the results (default: "include")
-    -i csv, --include csv
+      -i csv, --include csv
                             comma delimited list of glob patterns of paths to projects or groups to clone/pull
-    -x csv, --exclude csv
+      -x csv, --exclude csv
                             comma delimited list of glob patterns of paths to projects or groups to exclude from clone/pull
-    -r, --recursive       clone/pull git submodules recursively
-    -T, --hide-token      hide the token from the gitlab request URL (for method: http)
-    -f, --use-fetch       clone/fetch git repository (mirrored repositories)
-    -s, --include-shared  include shared projects in the results
-    --version             print the version
-
+      -r, --recursive       clone/pull git submodules recursively
+      -F, --use-fetch       clone/fetch git repository (mirrored repositories)
+      -d, --dont-checkout   don't checkout pulled git repository
+      -s, --include-shared  include shared projects in the results
+      --version             print the version
+    
     examples:
-
-        clone an entire gitlab tree using a base url and a token:
-        gitlabber -t <personal access token> -u <gitlab url> .
-
-        # the following examples assume you provided token/url in environment variables so these arguments are omitted
+    
+        clone an entire gitlab tree using a url and a token:
+        gitlabber -t <personal access token> -u <gitlab url>
+    
         only print the gitlab tree:
         gitlabber -p .
-
+    
         clone only projects under subgroup 'MySubGroup' to location '~/GitlabRoot':
         gitlabber -i '/MyGroup/MySubGroup**' ~/GitlabRoot
-
+    
         clone only projects under group 'MyGroup' excluding any projects under subgroup 'MySubGroup':
         gitlabber -i '/MyGroup**' -x '/MyGroup/MySubGroup**' .
-
+    
         clone an entire gitlab tree except projects under groups named 'ArchiveGroup':
         gitlabber -x '/ArchiveGroup**' .
-
+    
         clone projects that start with a case insensitive 'w' using a regular expression:
         gitlabber -i '/{[w].*}' .
 
+
 Debugging
 ---------
 * You can use the `--verbose` flag to print Gitlabber debug messages

gitlabber-1.2.2/gitlabber/__init__.py

@@ -0,0 +1 @@
+__version__ = '1.2.2'

{gitlabber-1.2.1 → gitlabber-1.2.2}/gitlabber/gitlab_tree.py

@@ -55,9 +55,8 @@ class GitlabTree:
         '''
         if self.includes is not None:
             for include in self.includes:
+                log.debug(f"Checking requested include: {include} with path: {node.root_path}, match {globre.match(include, node.root_path)}")
                 if globre.match(include, node.root_path):
-                    log.debug(
-                        "Matched include path [%s] to node [%s]", include, node.root_path)
                     return True
         else:
             return True
@@ -70,10 +69,10 @@ class GitlabTree:
         '''
         if self.excludes is not None:
             for exclude in self.excludes:
+                log.debug(f"Checking requested exclude: {exclude} with path: {node.root_path}, match {globre.match(exclude, node.root_path)}")
                 if globre.match(exclude, node.root_path):
-                    log.debug(
-                        "Matched exclude path [%s] to node [%s]", exclude, node.root_path)
                     return True
+        
         return False
 
     def filter_tree(self, parent):
@@ -122,7 +121,7 @@ class GitlabTree:
             log.error(f"Error getting projects on {group.name} (ID: {group.id}): {error} )")
 
     def get_subgroups(self, group, parent):
-        subgroups = group.subgroups.list(as_list=False, archived=self.archived)
+        subgroups = group.subgroups.list(as_list=False, archived=self.archived, get_all=True)
         self.progress.update_progress_length(len(subgroups))
         for subgroup_def in subgroups:
             try:
@@ -139,10 +138,8 @@ class GitlabTree:
                 else:
                     raise error
 
-
-
     def load_gitlab_tree(self):
-        groups = self.gitlab.groups.list(as_list=False, archived=self.archived)
+        groups = self.gitlab.groups.list(as_list=False, archived=self.archived, get_all=True)
         self.progress.init_progress(len(groups))
         for group in groups:
             if group.parent_id is None:

{gitlabber-1.2.1 → gitlabber-1.2.2/gitlabber.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlabber
-Version: 1.2.1
+Version: 1.2.2
 Summary: A Gitlab clone/pull utility for backing up or cloning Gitlab groups
 Home-page: https://github.com/ezbz/gitlabber
 Download-URL: https://github.com/ezbz/gitlabber/archive/master.zip
@@ -23,6 +23,13 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: docopt
+Requires-Dist: anytree
+Requires-Dist: globre
+Requires-Dist: pyyaml
+Requires-Dist: tqdm
+Requires-Dist: GitPython
+Requires-Dist: python-gitlab
 
 .. image:: https://github.com/ezbz/gitlabber/actions/workflows/python-app.yml/badge.svg?branch=master
     :target: https://github.com/ezbz/gitlabber/actions/workflows/python-app.yml
@@ -42,6 +49,7 @@ License-File: LICENSE.txt
 .. image:: https://readthedocs.org/projects/gitlabber/badge/?version=latest&style=plastic
     :target: https://gitlabber.readthedocs.io/en/latest/README.html
 
+
 Gitlabber
 =========
 
@@ -111,62 +119,61 @@ Usage
 
 .. code-block:: bash
 
-    usage: gitlabber [-h] [-t token] [-u url] [--verbose] [-p] [-d]
-                    [--print-format {json,yaml,tree}] [-m {ssh,https}] [-i csv]
-                    [-x csv] [--version] [-g {id,full_path,full_name}]
-                    [dest]
-
-    Gitlabber - clones or pulls entire groups/projects tree from GitLab
+ usage: gitlabber [-h] [-t token] [-T] [-u url] [--verbose] [-p] [--print-format {json,yaml,tree}] [-n {name,path}] [-m {ssh,http}] [-a {include,exclude,only}] [-i csv] [-x csv] [-r] [-F] [-d] [-s] [--version]
+                 [dest]
 
+    Gitlabber - clones or pulls entire groups/projects tree from gitlab
+    
     positional arguments:
-    dest                  destination path for the cloned tree (created if doesn't exist)
-
-    optional arguments:
-    -h, --help            show this help message and exit
-    -t token, --token token
+      dest                  destination path for the cloned tree (created if doesn't exist)
+    
+    options:
+      -h, --help            show this help message and exit
+      -t token, --token token
                             gitlab personal access token https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
-    -u url, --url url     base gitlab url (e.g.: 'http://gitlab.mycompany.com')
-    --verbose             print more verbose output
-    -p, --print           print the tree without cloning
-    --print-format {json,yaml,tree}
+      -T, --hide-token      use an inline URL token (avoids storing the gitlab personal access token in the .git/config)
+      -u url, --url url     base gitlab url (e.g.: 'http://gitlab.mycompany.com')
+      --verbose             print more verbose output
+      -p, --print           print the tree without cloning
+      --print-format {json,yaml,tree}
                             print format (default: 'tree')
-    -n {name,path}, --naming {name,path}
-                            the folder naming strategy for projects (default: "name")
-    -m {ssh,http}, --method {ssh,http}
+      -n {name,path}, --naming {name,path}
+                            the folder naming strategy for projects from the gitlab API attributes (default: "name")
+      -m {ssh,http}, --method {ssh,http}
                             the git transport method to use for cloning (default: "ssh")
-    -a {include,exclude,only}, --archived {include,exclude,only}
+      -a {include,exclude,only}, --archived {include,exclude,only}
                             include archived projects and groups in the results (default: "include")
-    -i csv, --include csv
+      -i csv, --include csv
                             comma delimited list of glob patterns of paths to projects or groups to clone/pull
-    -x csv, --exclude csv
+      -x csv, --exclude csv
                             comma delimited list of glob patterns of paths to projects or groups to exclude from clone/pull
-    -r, --recursive       clone/pull git submodules recursively
-    -T, --hide-token      hide the token from the gitlab request URL (for method: http)
-    -f, --use-fetch       clone/fetch git repository (mirrored repositories)
-    -s, --include-shared  include shared projects in the results
-    --version             print the version
-
+      -r, --recursive       clone/pull git submodules recursively
+      -F, --use-fetch       clone/fetch git repository (mirrored repositories)
+      -d, --dont-checkout   don't checkout pulled git repository
+      -s, --include-shared  include shared projects in the results
+      --version             print the version
+    
     examples:
-
-        clone an entire gitlab tree using a base url and a token:
-        gitlabber -t <personal access token> -u <gitlab url> .
-
-        # the following examples assume you provided token/url in environment variables so these arguments are omitted
+    
+        clone an entire gitlab tree using a url and a token:
+        gitlabber -t <personal access token> -u <gitlab url>
+    
         only print the gitlab tree:
         gitlabber -p .
-
+    
         clone only projects under subgroup 'MySubGroup' to location '~/GitlabRoot':
         gitlabber -i '/MyGroup/MySubGroup**' ~/GitlabRoot
-
+    
         clone only projects under group 'MyGroup' excluding any projects under subgroup 'MySubGroup':
         gitlabber -i '/MyGroup**' -x '/MyGroup/MySubGroup**' .
-
+    
         clone an entire gitlab tree except projects under groups named 'ArchiveGroup':
         gitlabber -x '/ArchiveGroup**' .
-
+    
         clone projects that start with a case insensitive 'w' using a regular expression:
         gitlabber -i '/{[w].*}' .
 
+
 Debugging
 ---------
 * You can use the `--verbose` flag to print Gitlabber debug messages

gitlabber-1.2.1/gitlabber/__init__.py

@@ -1 +0,0 @@
-__version__ = '1.2.1'