gitlabber 1.2.5.1__tar.gz → 1.2.7__tar.gz

{gitlabber-1.2.5.1/gitlabber.egg-info → gitlabber-1.2.7}/PKG-INFO

@@ -1,12 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: gitlabber
-Version: 1.2.5.1
+Version: 1.2.7
 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/main.zip
-Author: Erez Mazor
-Author-email: erezmazor@gmail.com
+Author-email: Erez Mazor <erezmazor@gmail.com>
 License: MIT
+Project-URL: Homepage, https://github.com/ezbz/gitlabber
+Project-URL: Download, https://github.com/ezbz/gitlabber/archive/main.zip
 Keywords: gitlab,python,cli
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -15,14 +14,26 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3
 Description-Content-Type: text/x-rst
 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
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-integration; extra == "test"
 
 .. 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
@@ -46,7 +57,7 @@ License-File: LICENSE.txt
 Gitlabber
 =========
 
-* A utility to clone and pull GitLab groups, subgroups, projects based on path selection
+* A utility to clone and pull GitLab groups, subgroups, group projects or personal user projects based on path selection
 
 
 Purpose
@@ -104,7 +115,7 @@ Usage
 
 * To see how to use glob patterns and regex to filter tree nodes, see the `globre project page <https://pypi.org/project/globre/#details>`_.
 
-* Include/Exclude patterns do not work at the API level but work on the results returned from the API, for large Gitlab installations this can take a lot of time, if you need to reduce the amound of API calls for such projects use the ``--group-search`` parameter to search only for the top level groups the interest you using the `Gitlab Group Search API <https://docs.gitlab.com/ee/api/groups.html#search-for-group>` which allows you to do a partial like query for a Group's path or name
+* Include/Exclude patterns do not work at the API level but work on the results returned from the API, for large Gitlab installations this can take a lot of time, if you need to reduce the amound of API calls for such projects use the ``--group-search`` parameter to search only for the top level groups the interest you using the `Gitlab Group Search API <https://docs.gitlab.com/ee/api/groups.html#search-for-group>`_ which allows you to do a partial like query for a Group's path or name
 
 * Cloning vs Pulling: when running Gitlabber consecutively with the same parameters, it will scan the local tree structure; if the project directory exists and is a valid git repository (has .git folder in it) Gitlabber will perform a git pull in the directory, otherwise the project directory will be created and the GitLab project will be cloned into it.
 
@@ -115,7 +126,7 @@ Usage
 .. code-block:: bash
 
     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] [-g term] [-U] [--version]
+                    [-a {include,exclude,only}] [-i csv] [-x csv] [-r] [-F] [-d] [-s] [-g term] [-U] [-o options] [--version]
                     [dest]
 
     Gitlabber - clones or pulls entire groups/projects tree from gitlab
@@ -150,6 +161,8 @@ Usage
     -g term, --group-search term
                             only include groups matching the search term, filtering done at the API level (useful for large projects, see: https://docs.gitlab.com/ee/api/groups.html#search-for-group works with partial names of path or name)
     -U, --user-projects   fetch only user personal projects (skips the group tree altogether, group related parameters are ignored). Clones personal projects to '{gitlab-username}-personal-projects'
+    -o options, --git-options options
+                            provide additional options as csv for the git command (e.g., --depth=1). See: clone/multi_options https://gitpython.readthedocs.io/en/stable/reference.html#
     --version             print the version
 
     examples:
@@ -172,6 +185,12 @@ Usage
         clone projects that start with a case insensitive 'w' using a regular expression:
         gitlabber -i '/{[w].*}' .
 
+        clone a user's personal projects to username-personal-projects
+        gitlabber -U .
+
+        perform a shallow clone of the git repositories
+        gitlabber -o "\-\-depth=1," .
+
 
 
 Debugging
@@ -193,3 +212,8 @@ Known Limitations
 * Renaming, moving and deleting projects: Gitlabber doesn't maintain local tree state (projects and groups). For that reason is does not rename move or delete local projects when they are modified on the server. When projects are moved or renamed, Gitlabber will clone them again under their new name or location. When deleted, Gitlabber will not delete the local project.
 * Folder naming strategy: Consecutively running Gitlabber with different values for the ``-n`` parameter will produce undesirable results. Use the same value as previous runs, or simply don't change it from the default (project name).
 * If you're going to clone a large number of projects, observe rate limits `for gitlab.com <https://docs.gitlab.com/ee/user/gitlab_com/index.html#gitlabcom-specific-rate-limits/>`_, and `for on-premise installations <https://docs.gitlab.com/ee/security/rate_limits.html>`_.
+
+
+Links
+-----
+* Gitlabber `tutorial <https://medium.com/@natskvi/clone-all-your-gitlab-groups-repos-before-starting-to-code-dd559ec5c8d6>`_ by nsk

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/README.rst

@@ -20,7 +20,7 @@
 Gitlabber
 =========
 
-* A utility to clone and pull GitLab groups, subgroups, projects based on path selection
+* A utility to clone and pull GitLab groups, subgroups, group projects or personal user projects based on path selection
 
 
 Purpose
@@ -78,7 +78,7 @@ Usage
 
 * To see how to use glob patterns and regex to filter tree nodes, see the `globre project page <https://pypi.org/project/globre/#details>`_.
 
-* Include/Exclude patterns do not work at the API level but work on the results returned from the API, for large Gitlab installations this can take a lot of time, if you need to reduce the amound of API calls for such projects use the ``--group-search`` parameter to search only for the top level groups the interest you using the `Gitlab Group Search API <https://docs.gitlab.com/ee/api/groups.html#search-for-group>` which allows you to do a partial like query for a Group's path or name
+* Include/Exclude patterns do not work at the API level but work on the results returned from the API, for large Gitlab installations this can take a lot of time, if you need to reduce the amound of API calls for such projects use the ``--group-search`` parameter to search only for the top level groups the interest you using the `Gitlab Group Search API <https://docs.gitlab.com/ee/api/groups.html#search-for-group>`_ which allows you to do a partial like query for a Group's path or name
 
 * Cloning vs Pulling: when running Gitlabber consecutively with the same parameters, it will scan the local tree structure; if the project directory exists and is a valid git repository (has .git folder in it) Gitlabber will perform a git pull in the directory, otherwise the project directory will be created and the GitLab project will be cloned into it.
 
@@ -89,7 +89,7 @@ Usage
 .. code-block:: bash
 
     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] [-g term] [-U] [--version]
+                    [-a {include,exclude,only}] [-i csv] [-x csv] [-r] [-F] [-d] [-s] [-g term] [-U] [-o options] [--version]
                     [dest]
 
     Gitlabber - clones or pulls entire groups/projects tree from gitlab
@@ -124,6 +124,8 @@ Usage
     -g term, --group-search term
                             only include groups matching the search term, filtering done at the API level (useful for large projects, see: https://docs.gitlab.com/ee/api/groups.html#search-for-group works with partial names of path or name)
     -U, --user-projects   fetch only user personal projects (skips the group tree altogether, group related parameters are ignored). Clones personal projects to '{gitlab-username}-personal-projects'
+    -o options, --git-options options
+                            provide additional options as csv for the git command (e.g., --depth=1). See: clone/multi_options https://gitpython.readthedocs.io/en/stable/reference.html#
     --version             print the version
 
     examples:
@@ -146,6 +148,12 @@ Usage
         clone projects that start with a case insensitive 'w' using a regular expression:
         gitlabber -i '/{[w].*}' .
 
+        clone a user's personal projects to username-personal-projects
+        gitlabber -U .
+
+        perform a shallow clone of the git repositories
+        gitlabber -o "\-\-depth=1," .
+
 
 
 Debugging
@@ -167,3 +175,8 @@ Known Limitations
 * Renaming, moving and deleting projects: Gitlabber doesn't maintain local tree state (projects and groups). For that reason is does not rename move or delete local projects when they are modified on the server. When projects are moved or renamed, Gitlabber will clone them again under their new name or location. When deleted, Gitlabber will not delete the local project.
 * Folder naming strategy: Consecutively running Gitlabber with different values for the ``-n`` parameter will produce undesirable results. Use the same value as previous runs, or simply don't change it from the default (project name).
 * If you're going to clone a large number of projects, observe rate limits `for gitlab.com <https://docs.gitlab.com/ee/user/gitlab_com/index.html#gitlabcom-specific-rate-limits/>`_, and `for on-premise installations <https://docs.gitlab.com/ee/security/rate_limits.html>`_.
+
+
+Links
+-----
+* Gitlabber `tutorial <https://medium.com/@natskvi/clone-all-your-gitlab-groups-repos-before-starting-to-code-dd559ec5c8d6>`_ by nsk

gitlabber-1.2.7/gitlabber/__init__.py

@@ -0,0 +1,2 @@
+""" Gitlabber """
+__version__ = '1.2.7'

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/gitlabber/cli.py

@@ -1,4 +1,3 @@
-
 import os
 import sys
 import logging
@@ -43,7 +42,8 @@ def main():
 
     tree = GitlabTree(args.url, args.token, args.method, args.naming, args.archived.api_value, includes,
                       excludes, args.file, args.concurrency, args.recursive, args.verbose,
-                      args.include_shared, args.use_fetch, args.hide_token, args.user_projects, group_search=args.group_search)
+                      args.include_shared, args.use_fetch, args.hide_token, args.user_projects, 
+                      group_search=args.group_search, git_options=args.git_options)
     tree.load_tree()
 
     if tree.is_empty():
@@ -72,7 +72,7 @@ def config_logging(args):
 
 
 def parse_args(argv=None):
-    example_text = '''examples:
+    example_text = r'''examples:
 
     clone an entire gitlab tree using a url and a token:
     gitlabber -t <personal access token> -u <gitlab url>
@@ -91,6 +91,12 @@ def parse_args(argv=None):
 
     clone projects that start with a case insensitive 'w' using a regular expression:
     gitlabber -i '/{[w].*}' .
+    
+    clone a user's personal projects to username-personal-projects
+    gitlabber -U .
+    
+    perform a shallow clone of the git repositories
+    gitlabber -o "\-\-depth=1," .
     '''
 
     parser = ArgumentParser(
@@ -216,6 +222,12 @@ def parse_args(argv=None):
         action='store_true',
         default=False,
         help='fetch only user personal projects (skips the group tree altogether, group related parameters are ignored). Clones personal projects to \'{gitlab-username}-personal-projects\'')
+    parser.add_argument(
+        '-o',
+        '--git-options',
+        nargs=1,
+        metavar=('options'),
+        help='provide additional options as csv for the git command (e.g., --depth=1). See: clone/multi_options https://gitpython.readthedocs.io/en/stable/reference.html#')
     parser.add_argument(
         '--version',
         action='store_true',

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/gitlabber/git.py

@@ -12,14 +12,15 @@ progress = ProgressBar('* syncing projects')
 
 
 class GitAction:
-    def __init__(self, node, path, recursive=False, use_fetch=False, hide_token=False):
+    def __init__(self, node, path, recursive=False, use_fetch=False, hide_token=False, git_options=None):
         self.node = node
         self.path = path
         self.recursive = recursive
         self.use_fetch = use_fetch
         self.hide_token = hide_token
+        self.git_options = git_options
 
-def sync_tree(root, dest, concurrency=1, disable_progress=False, recursive=False, use_fetch=False, hide_token=False):
+def sync_tree(root, dest, concurrency=1, disable_progress=False, recursive=False, use_fetch=False, hide_token=False, git_options=None):
     if not disable_progress:
         progress.init_progress(len(root.leaves))
     actions = get_git_actions(root, dest, recursive, use_fetch, hide_token)
@@ -71,7 +72,7 @@ def clone_or_pull_project(action):
             log.fatal("User interrupted")
             sys.exit(0)
         except Exception as e:
-            log.debug("Error pulling project %s", action.path, exc_info=True)
+            log.error("Error pulling project %s", action.path, exc_info=True)
     else:
         '''
         Clone new project
@@ -86,6 +87,8 @@ def clone_or_pull_project(action):
             multi_options.append('--recursive')
         if(action.use_fetch):
             multi_options.append('--mirror')
+        if(action.git_options):
+            multi_options += action.git_options.split(',')
         try:
             git.Repo.clone_from(action.node.url, action.path, multi_options=multi_options)
                 

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/gitlabber/gitlab_tree.py

@@ -18,7 +18,7 @@ log = logging.getLogger(__name__)
 
 class GitlabTree:
     def __init__(self, url, token, method, naming=None, archived=None, includes=[], excludes=[], in_file=None, concurrency=1, recursive=False, disable_progress=False,
-                include_shared=True, use_fetch=False, hide_token=False, user_projects=False, group_search=None):
+                include_shared=True, use_fetch=False, hide_token=False, user_projects=False, group_search=None, git_options=None):
         self.includes = includes
         self.excludes = excludes
         self.url = url
@@ -39,6 +39,7 @@ class GitlabTree:
         self.hide_token = hide_token
         self.user_projects = user_projects
         self.group_search = group_search
+        self.git_options = git_options
 
     @staticmethod
     def get_ca_path():

{gitlabber-1.2.5.1 → gitlabber-1.2.7/gitlabber.egg-info}/PKG-INFO

@@ -1,12 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: gitlabber
-Version: 1.2.5.1
+Version: 1.2.7
 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/main.zip
-Author: Erez Mazor
-Author-email: erezmazor@gmail.com
+Author-email: Erez Mazor <erezmazor@gmail.com>
 License: MIT
+Project-URL: Homepage, https://github.com/ezbz/gitlabber
+Project-URL: Download, https://github.com/ezbz/gitlabber/archive/main.zip
 Keywords: gitlab,python,cli
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -15,14 +14,26 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3
 Description-Content-Type: text/x-rst
 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
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-integration; extra == "test"
 
 .. 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
@@ -46,7 +57,7 @@ License-File: LICENSE.txt
 Gitlabber
 =========
 
-* A utility to clone and pull GitLab groups, subgroups, projects based on path selection
+* A utility to clone and pull GitLab groups, subgroups, group projects or personal user projects based on path selection
 
 
 Purpose
@@ -104,7 +115,7 @@ Usage
 
 * To see how to use glob patterns and regex to filter tree nodes, see the `globre project page <https://pypi.org/project/globre/#details>`_.
 
-* Include/Exclude patterns do not work at the API level but work on the results returned from the API, for large Gitlab installations this can take a lot of time, if you need to reduce the amound of API calls for such projects use the ``--group-search`` parameter to search only for the top level groups the interest you using the `Gitlab Group Search API <https://docs.gitlab.com/ee/api/groups.html#search-for-group>` which allows you to do a partial like query for a Group's path or name
+* Include/Exclude patterns do not work at the API level but work on the results returned from the API, for large Gitlab installations this can take a lot of time, if you need to reduce the amound of API calls for such projects use the ``--group-search`` parameter to search only for the top level groups the interest you using the `Gitlab Group Search API <https://docs.gitlab.com/ee/api/groups.html#search-for-group>`_ which allows you to do a partial like query for a Group's path or name
 
 * Cloning vs Pulling: when running Gitlabber consecutively with the same parameters, it will scan the local tree structure; if the project directory exists and is a valid git repository (has .git folder in it) Gitlabber will perform a git pull in the directory, otherwise the project directory will be created and the GitLab project will be cloned into it.
 
@@ -115,7 +126,7 @@ Usage
 .. code-block:: bash
 
     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] [-g term] [-U] [--version]
+                    [-a {include,exclude,only}] [-i csv] [-x csv] [-r] [-F] [-d] [-s] [-g term] [-U] [-o options] [--version]
                     [dest]
 
     Gitlabber - clones or pulls entire groups/projects tree from gitlab
@@ -150,6 +161,8 @@ Usage
     -g term, --group-search term
                             only include groups matching the search term, filtering done at the API level (useful for large projects, see: https://docs.gitlab.com/ee/api/groups.html#search-for-group works with partial names of path or name)
     -U, --user-projects   fetch only user personal projects (skips the group tree altogether, group related parameters are ignored). Clones personal projects to '{gitlab-username}-personal-projects'
+    -o options, --git-options options
+                            provide additional options as csv for the git command (e.g., --depth=1). See: clone/multi_options https://gitpython.readthedocs.io/en/stable/reference.html#
     --version             print the version
 
     examples:
@@ -172,6 +185,12 @@ Usage
         clone projects that start with a case insensitive 'w' using a regular expression:
         gitlabber -i '/{[w].*}' .
 
+        clone a user's personal projects to username-personal-projects
+        gitlabber -U .
+
+        perform a shallow clone of the git repositories
+        gitlabber -o "\-\-depth=1," .
+
 
 
 Debugging
@@ -193,3 +212,8 @@ Known Limitations
 * Renaming, moving and deleting projects: Gitlabber doesn't maintain local tree state (projects and groups). For that reason is does not rename move or delete local projects when they are modified on the server. When projects are moved or renamed, Gitlabber will clone them again under their new name or location. When deleted, Gitlabber will not delete the local project.
 * Folder naming strategy: Consecutively running Gitlabber with different values for the ``-n`` parameter will produce undesirable results. Use the same value as previous runs, or simply don't change it from the default (project name).
 * If you're going to clone a large number of projects, observe rate limits `for gitlab.com <https://docs.gitlab.com/ee/user/gitlab_com/index.html#gitlabcom-specific-rate-limits/>`_, and `for on-premise installations <https://docs.gitlab.com/ee/security/rate_limits.html>`_.
+
+
+Links
+-----
+* Gitlabber `tutorial <https://medium.com/@natskvi/clone-all-your-gitlab-groups-repos-before-starting-to-code-dd559ec5c8d6>`_ by nsk

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/gitlabber.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 LICENSE.txt
 MANIFEST.in
 README.rst
+pyproject.toml
 setup.cfg
 setup.py
 gitlabber/__init__.py

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/gitlabber.egg-info/requires.txt

@@ -5,3 +5,9 @@ pyyaml
 tqdm
 GitPython
 python-gitlab
+
+[test]
+coverage
+pytest
+pytest-cov
+pytest-integration

gitlabber-1.2.7/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gitlabber"
+version = "1.2.7"
+description = "A Gitlab clone/pull utility for backing up or cloning Gitlab groups"
+readme = "README.rst"
+requires-python = ">=3"
+license = {text = "MIT"}
+authors = [
+    {name = "Erez Mazor", email = "erezmazor@gmail.com"},
+]
+keywords = ["gitlab", "python", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Utilities",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "docopt",
+    "anytree",
+    "globre",
+    "pyyaml",
+    "tqdm",
+    "GitPython",
+    "python-gitlab",
+]
+
+[project.optional-dependencies]
+test = [
+    "coverage",
+    "pytest",
+    "pytest-cov",
+    "pytest-integration",
+]
+
+[project.urls]
+Homepage = "https://github.com/ezbz/gitlabber"
+Download = "https://github.com/ezbz/gitlabber/archive/main.zip"
+
+[project.scripts]
+gitlabber = "gitlabber.cli:main"
+
+[tool.setuptools]
+packages = ["gitlabber"]
+include-package-data = true

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/setup.cfg

@@ -2,7 +2,7 @@
 universal = 1
 
 [metadata]
-description-file = README.rst
+description_file = README.rst
 
 [coverage:run]
 parallel = true

gitlabber-1.2.7/setup.py

@@ -0,0 +1,90 @@
+from setuptools import setup
+
+setup()
+
+
+# """Packaging settings."""
+
+
+# from codecs import open
+# from os.path import abspath, dirname, join
+# from subprocess import call
+
+# from setuptools import Command, find_packages, setup
+
+# this_dir = abspath(dirname(__file__))
+# with open(join(this_dir, 'README.rst'), encoding='utf-8') as file:
+#     long_description = file.read()
+
+
+# class RunTests(Command):
+#     """Run all tests."""
+#     description = 'run tests'
+#     user_options = []
+
+#     def initialize_options(self):
+#         pass
+
+#     def finalize_options(self):
+#         pass
+
+#     def run(self):
+#         """Run all tests!"""
+#         errno = call(['py.test'])
+#         raise SystemExit(errno)
+# setup(
+#     python_requires='>=3',
+#     name = 'gitlabber',
+#     packages = find_packages(include=['gitlabber']),
+#     version = '1.2.7',
+#     description = 'A Gitlab clone/pull utility for backing up or cloning Gitlab groups',
+#     long_description = long_description,
+#     long_description_content_type="text/x-rst",
+#     url = 'https://github.com/ezbz/gitlabber',
+#     download_url = 'https://github.com/ezbz/gitlabber/archive/main.zip',
+#     author = 'Erez Mazor',
+#     author_email = 'erezmazor@gmail.com',
+#     license = 'MIT',
+#     keywords = ['gitlab', 'python', 'cli'], 
+#     include_package_data = True,
+
+#     classifiers = [
+#         'Development Status :: 4 - Beta',   
+#         'Intended Audience :: Developers',
+#         'Topic :: Utilities',
+#         'License :: OSI Approved :: MIT License',
+#         'Natural Language :: English',
+#         'Operating System :: OS Independent',
+#         'Programming Language :: Python :: 3',     
+#         'Programming Language :: Python :: 3.9',
+#         'Programming Language :: Python :: 3.10',
+#         'Programming Language :: Python :: 3.11',
+#         'Programming Language :: Python :: 3.12',
+#         'Programming Language :: Python :: 3.13'
+#     ],
+#     setup_requires = [
+#             'docopt', 
+#             'anytree', 
+#             'globre',
+#             'pyyaml',
+#             'tqdm',
+#             'GitPython', 
+#             'python-gitlab'
+#     ],
+#     install_requires = [
+#             'docopt', 
+#             'anytree', 
+#             'globre', 
+#             'pyyaml',
+#             'tqdm',
+#             'GitPython', 
+#             'python-gitlab'
+#     ],
+#     tests_require=  ['coverage', 'pytest', 'pytest-cov', 'pytest-integration'],
+#     entry_points = {
+#         'console_scripts': [
+#             'gitlabber=gitlabber.cli:main',
+#         ],
+#     },
+#     cmdclass = {'test': RunTests},
+# )

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/tests/gitlab_test_utils.py

@@ -2,6 +2,7 @@ import pytest
 import json
 from unittest import mock
 from gitlabber import gitlab_tree
+from gitlabber.method import CloneMethod
 
 URL = "http://gitlab.my.com/"
 TOKEN = "MOCK_TOKEN"
@@ -12,6 +13,7 @@ SUBGROUP_URL = "http://gitlab.my.com/group/subgroup"
 SUBGROUP_NAME = "subgroup"
 
 PROJECT_URL = "http://gitlab.my.com/group/subgroup/project/project.git"
+PROJECT_URL_WITH_TOKEN = "http://gitlab-token:xxx@gitlab.my.com/group/subgroup/project/project.git"
 PROJECT_NAME = "project"
 
 YAML_TEST_INPUT_FILE = "tests/test-input.yaml"
@@ -21,7 +23,7 @@ TREE_TEST_OUTPUT_FILE = "tests/test-output.tree"
 
 
 class MockNode:
-    def __init__(self, type, id, name, url, subgroups=mock.MagicMock(), projects=mock.MagicMock(), parent_id=None, archived=0, shared=False, group_search=None):
+    def __init__(self, type, id, name, url, subgroups=mock.MagicMock(), projects=mock.MagicMock(), parent_id=None, archived=0, shared=False, group_search=None, git_options=None):
         self.type = type
         self.id = id
         self.name = name
@@ -117,10 +119,10 @@ def validate_tree(root):
     validate_subgroup(root.children[0].children[0])
     validate_project(root.children[0].children[0].children[0])
 
-def create_test_gitlab(monkeypatch, includes=None, excludes=None, in_file=None):
+def create_test_gitlab(monkeypatch, includes=None, excludes=None, in_file=None, hide_token=True, method=CloneMethod.SSH):
     gl = gitlab_tree.GitlabTree(
-        URL, TOKEN, "ssh", "name", includes=includes, excludes=excludes, in_file=in_file)
-    projects = Listable(MockNode("project", 2, PROJECT_NAME, PROJECT_URL))
+        URL, TOKEN, "ssh", "name", includes=includes, excludes=excludes, in_file=in_file, hide_token=hide_token)
+    projects = Listable(MockNode("project", 2, PROJECT_NAME, PROJECT_URL if hide_token else PROJECT_URL_WITH_TOKEN))
     groups = Listable(
             MockNode("group", 2, GROUP_NAME, GROUP_URL, subgroups=Listable(
             MockNode("subgroup", 3, SUBGROUP_NAME, SUBGROUP_URL, projects=projects)

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/tests/test_cli.py

@@ -36,7 +36,7 @@ def test_args_version():
 def test_args_logging(mock_tree, mock_log, mock_os, mock_sys, mock_logging):
     args_mock = mock.Mock()
     args_mock.return_value = Node(
-        type="test", name="test", version=None, verbose=True, include="", exclude="", url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.PATH, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=None, dest=".", include_shared=True, use_fetch=None, hide_token=None, user_projects=None, group_search=None)
+        type="test", name="test", version=None, verbose=True, include="", exclude="", url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.PATH, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=None, dest=".", include_shared=True, use_fetch=None, hide_token=None, user_projects=None, group_search=None, git_options=None)
     cli.parse_args = args_mock
 
     mock_streamhandler = mock.Mock()
@@ -57,7 +57,7 @@ def test_args_include(mock_tree):
     exc_groups = "/exc**,/exc**"
     args_mock = mock.Mock()
     args_mock.return_value = Node(
-        type="test", name="test", version=None, debug=None, include=inc_groups, exclude=exc_groups, url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.NAME, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=None, dest=".", use_fetch=None, hide_token=None, user_projects=None, group_search=None)
+        type="test", name="test", version=None, debug=None, include=inc_groups, exclude=exc_groups, url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.NAME, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=None, dest=".", use_fetch=None, hide_token=None, user_projects=None, group_search=None, git_options=None)
     cli.parse_args = args_mock
 
     split_mock = mock.Mock()
@@ -73,7 +73,7 @@ def test_args_include(mock_tree):
 def test_args_include(mock_tree):
     args_mock = mock.Mock()
     args_mock.return_value = Node(
-        type="test", name="test", version=None, verbose=None, include="", exclude="", url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.NAME, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=True, dest=".", print_format=PrintFormat.YAML, include_shared=True, use_fetch=None, hide_token=None, user_projects=None, group_search=None)
+        type="test", name="test", version=None, verbose=None, include="", exclude="", url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.NAME, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=True, dest=".", print_format=PrintFormat.YAML, include_shared=True, use_fetch=None, hide_token=None, user_projects=None, group_search=None, git_options=None)
     cli.parse_args = args_mock
 
     print_tree_mock = mock.Mock()
@@ -116,7 +116,7 @@ def test_missing_url(mock_tree):
 def test_empty_tree(mock_tree):
     args_mock = mock.Mock()
     args_mock.return_value = Node(
-        type="test", name="test", version=None, verbose=None, include="", exclude="", url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.NAME, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=True, dest=".", include_shared=True, use_fetch=None, hide_token=None, user_projects=None, group_search=None)
+        type="test", name="test", version=None, verbose=None, include="", exclude="", url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.NAME, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=True, dest=".", include_shared=True, use_fetch=None, hide_token=None, user_projects=None, group_search=None, git_options=None)
     cli.parse_args = args_mock
 
     with pytest.raises(SystemExit):
@@ -127,7 +127,7 @@ def test_empty_tree(mock_tree):
 def test_missing_dest(mock_tree, capsys):
     args_mock = mock.Mock()
     args_mock.return_value = Node(
-        type="test", name="test", version=None, verbose=None, include="", exclude="", url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.NAME, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=False, dest=None, group_search=None)
+        type="test", name="test", version=None, verbose=None, include="", exclude="", url="test_url", token="test_token", method=CloneMethod.SSH, naming=FolderNaming.NAME, archived=ArchivedResults.INCLUDE, file=None, concurrency=1, recursive=False, disble_progress=True, print=False, dest=None, group_search=None, git_options=None)
     cli.parse_args = args_mock
     mock_tree.return_value.is_empty = mock.Mock(return_value=False)
 

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/tests/test_git.py

@@ -115,6 +115,20 @@ def test_pull_repo_exception(mock_git):
 
     mock_git.Repo.assert_called_once_with("dummy_dir")
     repo_instance.remotes.origin.pull.assert_called_once()
+    
+@mock.patch('gitlabber.git.git')
+def test_clone_repo_exception(mock_git):
+    mock_repo = mock.Mock()
+    mock_git.Repo = mock_repo
+    git.is_git_repo = mock.MagicMock(return_value=False)
+    
+    repo_instance = mock_git.Repo.return_value
+    repo_instance.clone_from.side_effect=Exception('clone test exception')
+
+    git.clone_or_pull_project(
+        GitAction(Node(type="project", name="dummy_url", url="dummy_url"), "dummy_dir"))
+    mock_git.Repo.clone_from.assert_called_once_with('dummy_url', 'dummy_dir', multi_options=[])
+    mock_git.Repo.clone_from.assert_called_once()
 
 @mock.patch('gitlabber.git.git')
 def test_pull_repo_interrupt(mock_git):
@@ -144,3 +158,27 @@ def test_clone_repo_interrupt(mock_git):
             Node(type="project", name="dummy_url", url="dummy_url"), "dummy_dir"))
 
     mock_git.Repo.clone_from.assert_called_once_with("dummy_url", "dummy_dir", multi_options=[])
+
+
+@mock.patch('gitlabber.git.git')
+def test_clone_repo_options_many_options(mock_git):
+    mock_repo = mock.Mock()
+    mock_git.Repo = mock_repo
+    git.is_git_repo = mock.MagicMock(return_value=False)
+
+    git.clone_or_pull_project(
+        GitAction(Node(type="project", name="dummy_url", url="dummy_url"), "dummy_dir", git_options="--opt1=1,--opt2=2"))
+
+    mock_git.Repo.clone_from.assert_called_once_with("dummy_url", "dummy_dir", multi_options=['--opt1=1','--opt2=2'])
+    
+    
+@mock.patch('gitlabber.git.git')
+def test_clone_repo_options_with_recursive(mock_git):
+    mock_repo = mock.Mock()
+    mock_git.Repo = mock_repo
+    git.is_git_repo = mock.MagicMock(return_value=False)
+
+    git.clone_or_pull_project(
+        GitAction(Node(type="project", name="dummy_url", url="dummy_url"), "dummy_dir", recursive=True, git_options="--opt1=1,--opt2=2"))
+
+    mock_git.Repo.clone_from.assert_called_once_with("dummy_url", "dummy_dir", multi_options=['--recursive','--opt1=1','--opt2=2'])

{gitlabber-1.2.5.1 → gitlabber-1.2.7}/tests/test_gitlab_tree.py

@@ -1,4 +1,5 @@
 
+from gitlabber.method import CloneMethod
 import tests.gitlab_test_utils as gitlab_util
 import tests.io_test_util as output_util
 from gitlabber.archive import ArchivedResults
@@ -164,4 +165,11 @@ def test_shared_excluded(monkeypatch):
     assert len(gl.root.children) == 1
     assert len(gl.root.children[0].children) == 1
 
-    assert "project" in gl.root.children[0].children[0].name
+    assert "project" in gl.root.children[0].children[0].name
+    
+    
+def test_hide_token_from_project_url(monkeypatch):
+    gl = gitlab_util.create_test_gitlab(monkeypatch, hide_token=True, method=CloneMethod.HTTP)
+    gl.load_tree()
+    gl.print_tree()
+    assert 'gitlab-token:xxx@' not in gl.root.children[0].children[0].children[0].url

gitlabber-1.2.5.1/gitlabber/__init__.py

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

gitlabber-1.2.5.1/setup.py

@@ -1,89 +0,0 @@
-"""Packaging settings."""
-
-
-from codecs import open
-import os
-from os.path import abspath, dirname, join
-from subprocess import call
-
-from setuptools import Command, find_packages, setup
-
-from gitlabber import __version__
-
-
-this_dir = abspath(dirname(__file__))
-with open(join(this_dir, 'README.rst'), encoding='utf-8') as file:
-    long_description = file.read()
-
-
-class RunTests(Command):
-    """Run all tests."""
-    description = 'run tests'
-    user_options = []
-
-    def initialize_options(self):
-        pass
-
-    def finalize_options(self):
-        pass
-
-    def run(self):
-        """Run all tests!"""
-        errno = call(['py.test'])
-        raise SystemExit(errno)
-setup(
-    python_requires='>=3',
-    name = 'gitlabber',
-    packages = ['gitlabber'],
-    version = __version__,
-    description = 'A Gitlab clone/pull utility for backing up or cloning Gitlab groups',
-    long_description = long_description,
-    long_description_content_type="text/x-rst",
-    url = 'https://github.com/ezbz/gitlabber',
-    download_url = 'https://github.com/ezbz/gitlabber/archive/main.zip',
-    author = 'Erez Mazor',
-    author_email = 'erezmazor@gmail.com',
-    license = 'MIT',
-    keywords = ['gitlab', 'python', 'cli'], 
-    include_package_data = True,
-
-    classifiers = [
-        'Development Status :: 4 - Beta',   
-        'Intended Audience :: Developers',
-        'Topic :: Utilities',
-        'License :: OSI Approved :: MIT License',
-        'Natural Language :: English',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python :: 3',     
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-        'Programming Language :: Python :: 3.10',
-        'Programming Language :: Python :: 3.11',
-        'Programming Language :: Python :: 3.12'
-    ],
-    setup_requires = [
-            'docopt', 
-            'anytree', 
-            'globre',
-            'pyyaml',
-            'tqdm',
-            'GitPython', 
-            'python-gitlab'
-    ],
-    install_requires = [
-            'docopt', 
-            'anytree', 
-            'globre', 
-            'pyyaml',
-            'tqdm',
-            'GitPython', 
-            'python-gitlab'
-    ],
-    tests_require=  ['coverage', 'pytest', 'pytest-cov', 'pytest-integration'],
-    entry_points = {
-        'console_scripts': [
-            'gitlabber=gitlabber.cli:main',
-        ],
-    },
-    cmdclass = {'test': RunTests},
-)