gitlab-projects-settings 1.0.0__py3-none-any.whl

gitlab_projects_settings/__init__.py

@@ -0,0 +1,5 @@
+# Components
+from gitlab_projects_settings.package.version import Version
+
+# Version
+__version__ = Version.get()

gitlab_projects_settings/__main__.py

@@ -0,0 +1,5 @@
+# Components
+from gitlab_projects_settings.cli.main import main
+
+# Entrypoint
+main()

gitlab_projects_settings/cli/main.py

@@ -0,0 +1,198 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from argparse import (_ArgumentGroup, ArgumentParser, Namespace, RawTextHelpFormatter)
+from os import environ
+from sys import exit as sys_exit
+
+# Components
+from ..features.settings import SettingsFeature
+from ..package.bundle import Bundle
+from ..package.version import Version
+from ..prints.colors import Colors
+from ..system.platform import Platform
+
+# Main, pylint: disable=too-many-statements
+def main() -> None:
+
+    # Variables
+    group: _ArgumentGroup
+    result: bool = False
+
+    # Arguments creation
+    parser: ArgumentParser = ArgumentParser(
+        prog=Bundle.NAME,
+        description=f'{Bundle.NAME}: {Bundle.DESCRIPTION}',
+        add_help=False,
+        formatter_class=RawTextHelpFormatter,
+    )
+
+    # Arguments internal definitions
+    group = parser.add_argument_group('internal arguments')
+    group.add_argument(
+        '-h',
+        '--help',
+        dest='help',
+        action='store_true',
+        help='Show this help message',
+    )
+    group.add_argument(
+        '--version',
+        dest='version',
+        action='store_true',
+        help='Show the current version',
+    )
+
+    # Arguments credentials definitions
+    group = parser.add_argument_group('credentials arguments')
+    group.add_argument(
+        '-t',
+        dest='token',
+        default=environ.get(Bundle.ENV_GITLAB_TOKEN, ''), #
+        help=f'GitLab API token (default: {Bundle.ENV_GITLAB_TOKEN} environment)',
+    )
+
+    # Arguments common settings definitions
+    group = parser.add_argument_group('common settings arguments')
+    group.add_argument(
+        '--dry-run',
+        dest='dry_run',
+        action='store_true',
+        help='Enable dry run mode to check without saving',
+    )
+    group.add_argument(
+        '--avoid-group',
+        dest='avoid_group',
+        action='store_true',
+        help='Avoid affecting parent group settings',
+    )
+    group.add_argument(
+        '--avoid-subgroups',
+        dest='avoid_subgroups',
+        action='store_true',
+        help='Avoid affecting children subgroups settings',
+    )
+    group.add_argument(
+        '--avoid-projects',
+        dest='avoid_projects',
+        action='store_true',
+        help='Avoid affecting children projects settings',
+    )
+
+    # Arguments general settings definitions
+    group = parser.add_argument_group('general settings arguments')
+    group.add_argument(
+        '--reset-features',
+        dest='reset_features',
+        action='store_true',
+        help='Reset features of GitLab projects based on usage',
+    )
+    group.add_argument(
+        '--reset-members',
+        dest='reset_members',
+        action='store_true',
+        help='Reset members of GitLab projects and groups',
+    )
+    group.add_argument(
+        '--set-avatar',
+        dest='set_avatar',
+        action='store',
+        metavar='FILE',
+        help='Set avatar of GitLab projects and groups',
+    )
+    group.add_argument(
+        '--set-description',
+        dest='set_description',
+        action='store',
+        metavar='DESCRIPTION',
+        help='Set description of GitLab projects and groups',
+    )
+    group.add_argument(
+        '--update-description',
+        dest='update_description',
+        action='store_true',
+        help='Update description of GitLab projects and groups automatically',
+    )
+
+    # Arguments repository settings definitions
+    group = parser.add_argument_group('repository settings arguments')
+    group.add_argument(
+        '--protect-branches',
+        dest='protect_branches',
+        action='store_true',
+        help='Protect branches with default master/main, develop and staging',
+    )
+    group.add_argument(
+        '--protect-tags',
+        dest='protect_tags',
+        action='store',
+        metavar='LEVEL',
+        help='Protect tags at level [no-one,admins,maintainers,developers]',
+    )
+
+    # Arguments positional definitions
+    group = parser.add_argument_group('positional arguments')
+    group.add_argument(
+        dest='gitlab',
+        action='store',
+        nargs='?',
+        default='https://gitlab.com',
+        help='GitLab URL (default: https://gitlab.com)',
+    )
+    group.add_argument(
+        dest='path',
+        action='store',
+        nargs='?',
+        help='GitLab group or project path',
+    )
+
+    # Arguments parser
+    options: Namespace = parser.parse_args()
+
+    # Help informations
+    if options.help:
+        print(' ')
+        parser.print_help()
+        print(' ')
+        Platform.flush()
+        sys_exit(0)
+
+    # Prepare colors
+    Colors.prepare()
+
+    # Version informations
+    if options.version:
+        print(
+            f'{Bundle.NAME} {Version.get()} from {Version.path()} (python {Version.python()})'
+        )
+        Platform.flush()
+        sys_exit(0)
+
+    # Arguments validation
+    if not options.token or not options.gitlab or not options.path:
+        print(' ')
+        parser.print_help()
+        print(' ')
+        Platform.flush()
+        sys_exit(1)
+
+    # Header
+    print(' ')
+    Platform.flush()
+
+    # Configure GitLab projects
+    result = SettingsFeature.entrypoint(options)
+
+    # Footer
+    print(' ')
+    Platform.flush()
+
+    # Result
+    if result:
+        sys_exit(0)
+    else:
+        sys_exit(1)
+
+# Entrypoint
+if __name__ == '__main__': # pragma: no cover
+    main()

gitlab_projects_settings/features/gitlab.py

@@ -0,0 +1,314 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from typing import List
+
+# Modules libraries
+from gitlab import Gitlab
+from gitlab.exceptions import GitlabListError
+from gitlab.v4.objects import Group, Project
+
+# GitLabFeature class
+class GitLabFeature:
+
+    # Members
+    __dry_run: bool = False
+    __gitlab: Gitlab
+
+    # Constructor
+    def __init__(self, url: str, token: str, dry_run: bool = False) -> None:
+        self.__dry_run = dry_run
+        self.__gitlab = Gitlab(url, private_token=token)
+        self.__gitlab.auth()
+
+    # Group
+    def group(self, criteria: str) -> Group:
+        return self.__gitlab.groups.get(criteria)
+
+    # Group reset members
+    def group_reset_members(self, criteria: str) -> None:
+
+        # Remove group members
+        group = self.group(criteria)
+        for member in group.members.list():
+            if not self.__dry_run:
+                group.members.delete(member.id)
+
+        # Save group
+        if not self.__dry_run:
+            group.save()
+
+    # Group set avatar
+    def group_set_avatar(self, criteria: str, file: str) -> None:
+
+        # Set group avatar
+        group = self.group(criteria)
+        with open(file, 'rb') as avatar:
+            group.avatar = avatar
+
+            # Save group
+            if not self.__dry_run:
+                group.save()
+
+    # Group set description
+    def group_set_description(self, criteria: str, description: str) -> None:
+
+        # Set group description
+        group = self.group(criteria)
+        group.description = description
+
+        # Save group
+        if not self.__dry_run:
+            group.save()
+
+    # Project
+    def project(self, criteria: str) -> Project:
+        return self.__gitlab.projects.get(criteria)
+
+    # Project protect branches
+    def project_protect_branches(self, criteria: str) -> List[str]:
+
+        # Validate project feature
+        result: List[str] = []
+        project = self.project(criteria)
+        try:
+            assert project.branches.list()
+        except (AssertionError, GitlabListError):
+            return result
+
+        # Acquire project, branches and protected branches
+        branches = [branch.name for branch in project.branches.list()]
+        protectedbranches = [
+            protectedbranch.name for protectedbranch in project.protectedbranches.list()
+        ]
+
+        # Protect main/master
+        for branch in ['main', 'master']:
+            if branch in branches and branch not in protectedbranches:
+                if not self.__dry_run:
+                    project.protectedbranches.create({
+                        'name': branch,
+                        'merge_access_level': 40,
+                        'push_access_level': 40,
+                        'allow_force_push': False
+                    })
+                result += [branch]
+
+        # Protect develop
+        for branch in ['develop']:
+            if branch in branches and branch not in protectedbranches:
+                if not self.__dry_run:
+                    project.protectedbranches.create({
+                        'name': branch,
+                        'merge_access_level': 40,
+                        'push_access_level': 40,
+                        'allow_force_push': True
+                    })
+                result += [branch]
+
+        # Protect staging
+        for branch in ['staging']:
+            if branch in branches and branch not in protectedbranches:
+                if not self.__dry_run:
+                    project.protectedbranches.create({
+                        'name': branch,
+                        'merge_access_level': 30,
+                        'push_access_level': 30,
+                        'allow_force_push': True
+                    })
+                result += [branch]
+
+        # Save project
+        if not self.__dry_run:
+            project.save()
+
+        # Result
+        return result
+
+    # Project protect tags, pylint: disable=too-many-branches
+    def project_protect_tags(self, criteria: str, protect_level: str) -> List[str]:
+
+        # Validate project feature
+        result: List[str] = []
+        project = self.project(criteria)
+        try:
+            assert project.tags.list()
+        except (AssertionError, GitlabListError):
+            return result
+
+        # Prepare access level
+        access_level: int
+        if protect_level == 'no-one':
+            access_level = 0
+        elif protect_level == 'admins':
+            access_level = 60
+        elif protect_level == 'maintainers':
+            access_level = 40
+        elif protect_level == 'developers':
+            access_level = 30
+        else:
+            raise SyntaxError(f'Unknown protection level: {access_level}')
+
+        # Acquire protected tags
+        protectedtags = [
+            protectedtag.name for protectedtag in project.protectedtags.list()
+        ]
+
+        # Update protected tags
+        for protectedtag in project.protectedtags.list():
+            protectedtag_level = protectedtag.create_access_levels[0]['access_level']
+            if protectedtag_level != 0 and (access_level == 0
+                                            or protectedtag_level < access_level):
+                name = protectedtag.name
+                if not self.__dry_run:
+                    protectedtag.delete()
+                    project.protectedtags.create({
+                        'name': name,
+                        'create_access_level': access_level
+                    })
+                result += [name]
+
+        # Protect unprotected tags
+        for tag in project.tags.list():
+            if tag.name not in protectedtags:
+                if not self.__dry_run:
+                    project.protectedtags.create({
+                        'name': tag.name,
+                        'create_access_level': access_level
+                    })
+                result += [tag.name]
+
+        # Save project
+        if not self.__dry_run:
+            project.save()
+
+        # Result
+        result.sort()
+        return result
+
+    # Project reset features, pylint: disable=too-many-branches,too-many-statements
+    def project_reset_features(self, criteria: str) -> List[str]:
+
+        # Variables
+        result: List[str] = []
+        project = self.__gitlab.projects.get(criteria, statistics=True)
+
+        # Disable unused features
+        if project.issues_enabled and not project.issues.list(get_all=False):
+            project.issues_enabled = False
+            result += ['Issues']
+        try:
+            assert project.commits.list(get_all=False)
+        except (AssertionError, GitlabListError):
+            if project.repository_access_level != 'disabled':
+                project.repository_access_level = 'disabled'
+                result += ['Repository']
+        if project.merge_requests_enabled and not project.mergerequests.list(
+                get_all=False):
+            project.merge_requests_enabled = False
+            result += ['Merge requests']
+        if project.forking_access_level != 'disabled' and not project.forks.list(
+                get_all=False):
+            project.forking_access_level = 'disabled'
+            result += ['Forks']
+        if project.lfs_enabled and project.statistics['lfs_objects_size'] == 0:
+            project.lfs_enabled = False
+            result += ['Git LFS']
+        if project.jobs_enabled and not project.jobs.list(get_all=False):
+            project.jobs_enabled = False
+            result += ['CI/CD']
+        if project.container_registry_enabled and not project.repositories.list(
+                get_all=False):
+            project.container_registry_enabled = False
+            result += ['Container registry']
+        if project.analytics_access_level != 'disabled':
+            project.analytics_access_level = 'disabled'
+            result += ['Analytics']
+        if project.security_and_compliance_access_level != 'disabled':
+            project.security_and_compliance_access_level = 'disabled'
+            result += ['Security and Compliance']
+        if project.wiki_enabled and not project.wikis.list(get_all=False):
+            project.wiki_enabled = False
+            result += ['Wiki']
+        if project.snippets_enabled and not project.snippets.list(get_all=False):
+            project.snippets_enabled = False
+            result += ['Snippets']
+        if project.packages_enabled and not project.packages.list(get_all=False):
+            project.packages_enabled = False
+            result += ['Package registry']
+        if project.model_experiments_access_level != 'disabled':
+            project.model_experiments_access_level = 'disabled'
+            result += ['Model experiments']
+        if project.model_registry_access_level != 'disabled':
+            project.model_registry_access_level = 'disabled'
+            result += ['Model registry']
+        if project.pages_access_level != 'disabled':
+            project.pages_access_level = 'disabled'
+            result += ['Pages']
+        if project.monitor_access_level != 'disabled':
+            project.monitor_access_level = 'disabled'
+            result += ['Monitor']
+        try:
+            assert project.environments.list(get_all=False)
+        except (AssertionError, GitlabListError):
+            if project.environments_access_level != 'disabled':
+                project.environments_access_level = 'disabled'
+                result += ['Environments']
+        if project.feature_flags_access_level != 'disabled':
+            project.feature_flags_access_level = 'disabled'
+            result += ['Feature flags']
+        if project.infrastructure_access_level != 'disabled':
+            project.infrastructure_access_level = 'disabled'
+            result += ['Infrastructure']
+        if project.releases_access_level != 'disabled' and not project.releases.list(
+                get_all=False):
+            project.releases_access_level = 'disabled'
+            result += ['Releases']
+        if project.service_desk_enabled:
+            project.service_desk_enabled = False
+            result += ['Service Desk']
+        if project.auto_devops_enabled:
+            project.auto_devops_enabled = False
+            result += ['Auto DevOps']
+
+        # Save project
+        if not self.__dry_run:
+            project.save()
+
+        # Result
+        return result
+
+    # Project reset members
+    def project_reset_members(self, criteria: str) -> None:
+
+        # Remove project members
+        project = self.project(criteria)
+        for member in project.members.list():
+            if not self.__dry_run:
+                project.members.delete(member.id)
+
+        # Save project
+        if not self.__dry_run:
+            project.save()
+
+    # Project set avatar
+    def project_set_avatar(self, criteria: str, file: str) -> None:
+
+        # Set project avatar
+        project = self.project(criteria)
+        with open(file, 'rb') as avatar:
+            project.avatar = avatar
+            if not self.__dry_run:
+                project.save()
+
+    # Project set description
+    def project_set_description(self, criteria: str, description: str) -> None:
+        project = self.project(criteria)
+        project.description = description
+        if not self.__dry_run:
+            project.save()
+
+    # URL
+    @property
+    def url(self) -> str:
+        return str(self.__gitlab.api_url)

gitlab_projects_settings/features/settings.py

@@ -0,0 +1,213 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from argparse import Namespace
+
+# Modules libraries
+from gitlab.exceptions import GitlabGetError
+from gitlab.v4.objects import Group, Project
+
+# Components
+from ..features.gitlab import GitLabFeature
+from ..prints.colors import Colors
+from ..system.platform import Platform
+
+# SettingsFeature class, pylint: disable=too-few-public-methods
+class SettingsFeature:
+
+    # Entrypoint
+    @staticmethod
+    def entrypoint(options: Namespace) -> bool:
+
+        # Variables
+        group: Group = None
+        project: Project = None
+
+        # Header
+        print(' ')
+
+        # GitLab client
+        gitlab = GitLabFeature(options.gitlab, options.token, options.dry_run)
+        print(f'{Colors.BOLD} - GitLab host: '
+              f'{Colors.GREEN}{gitlab.url}'
+              f'{Colors.RESET}')
+        Platform.flush()
+
+        # GitLab path
+        try:
+            group = gitlab.group(options.path)
+            print(f'{Colors.BOLD} - GitLab group: '
+                  f'{Colors.GREEN}{group.full_path} ({group.description})'
+                  f'{Colors.RESET}')
+            print(' ')
+            Platform.flush()
+        except GitlabGetError:
+            project = gitlab.project(options.path)
+            print(f'{Colors.BOLD} - GitLab project: '
+                  f'{Colors.GREEN}{project.path_with_namespace} ({project.description})'
+                  f'{Colors.RESET}')
+            print(' ')
+            Platform.flush()
+
+        # Handle single project
+        if project:
+            SettingsFeature.project(options, gitlab, project.id)
+
+        # Handle group recursively
+        elif group:
+
+            # Handle group
+            if not options.avoid_group:
+                SettingsFeature.group(options, gitlab, group.id)
+
+            # Iterate through subgroups
+            if not options.avoid_subgroups:
+                for group_subgroup in group.descendant_groups.list(
+                        get_all=True,
+                        include_subgroups=True,
+                        order_by='path',
+                        sort='asc',
+                ):
+                    SettingsFeature.group(options, gitlab, group_subgroup.id)
+
+            # Iterate through projects
+            if not options.avoid_projects:
+                for group_project in group.projects.list(
+                        get_all=True,
+                        include_subgroups=not options.avoid_subgroups,
+                        order_by='path',
+                        sort='asc',
+                ):
+                    SettingsFeature.project(options, gitlab, group_project.id)
+
+        # Result
+        return True
+
+    # GitLab projects settings project, pylint: disable=too-many-branches
+    @staticmethod
+    def project(options: Namespace, gitlab: GitLabFeature, criteria: str) -> None:
+
+        # Show project details
+        project = gitlab.project(criteria)
+        print(f'{Colors.BOLD} - GitLab project: '
+              f'{Colors.YELLOW_LIGHT}{project.path_with_namespace} '
+              f'{Colors.CYAN}({project.description})'
+              f'{Colors.RESET}')
+
+        # Set project description
+        if options.set_description:
+            gitlab.project_set_description(criteria, options.set_description)
+            print(f'{Colors.BOLD}   - Set description: '
+                  f'{Colors.CYAN}{options.set_description}'
+                  f'{Colors.RESET}')
+
+        # Update project description
+        elif options.update_description:
+            description = f'{project.name[:1].capitalize()}{project.name[1:]}' \
+                            f' - description'
+            gitlab.project_set_description(criteria, description)
+            print(f'{Colors.BOLD}   - Updated description: '
+                  f'{Colors.CYAN}{description}'
+                  f'{Colors.RESET}')
+
+        # Reset project features
+        if options.reset_features:
+            features = ', '.join(gitlab.project_reset_features(criteria))
+            if features:
+                print(f'{Colors.BOLD}   - Reset features: '
+                      f'{Colors.CYAN}{features}'
+                      f'{Colors.RESET}')
+            else:
+                print(f'{Colors.BOLD}   - Reset features: '
+                      f'{Colors.GREEN}Already done'
+                      f'{Colors.RESET}')
+
+        # Reset project members
+        if options.reset_members:
+            gitlab.project_reset_members(criteria)
+            print(f'{Colors.BOLD}   - Reset members: '
+                  f'{Colors.GREEN}Success'
+                  f'{Colors.RESET}')
+
+        # Set project avatar
+        if options.set_avatar:
+            gitlab.project_set_avatar(criteria, options.set_avatar)
+            print(f'{Colors.BOLD}   - Set avatar: '
+                  f'{Colors.CYAN}{options.set_avatar}'
+                  f'{Colors.RESET}')
+
+        # Protect project branches
+        if options.protect_branches:
+            branches = ', '.join(gitlab.project_protect_branches(criteria))
+            if branches:
+                print(f'{Colors.BOLD}   - Protecting branches: '
+                      f'{Colors.CYAN}{branches}'
+                      f'{Colors.RESET}')
+            else:
+                print(f'{Colors.BOLD}   - Protecting branches: '
+                      f'{Colors.GREEN}Already done'
+                      f'{Colors.RESET}')
+
+        # Protect project tags
+        if options.protect_tags:
+            tags = ', '.join(gitlab.project_protect_tags(criteria, options.protect_tags))
+            if tags:
+                print(f'{Colors.BOLD}   - Protecting tags: '
+                      f'{Colors.CYAN}{tags}'
+                      f'{Colors.GREEN} (level: {options.protect_tags})'
+                      f'{Colors.RESET}')
+            else:
+                print(f'{Colors.BOLD}   - Protecting tags: '
+                      f'{Colors.GREEN}Already done'
+                      f'{Colors.RESET}')
+
+        # Footer
+        print(' ')
+        Platform.flush()
+
+    # GitLab projects settings group
+    @staticmethod
+    def group(options: Namespace, gitlab: GitLabFeature, criteria: str,
+              subgroup: bool = False) -> None:
+
+        # Show group details
+        group = gitlab.group(criteria)
+        group_type = 'subgroup' if subgroup else 'group'
+        print(f'{Colors.BOLD} - GitLab {group_type}: '
+              f'{Colors.YELLOW_LIGHT}{group.full_path} '
+              f'{Colors.CYAN}({group.description})'
+              f'{Colors.RESET}')
+
+        # Set group description
+        if options.set_description:
+            gitlab.group_set_description(criteria, options.set_description)
+            print(f'{Colors.BOLD}   - Set description: '
+                  f'{Colors.CYAN}{options.set_description}'
+                  f'{Colors.RESET}')
+
+        # Update group description
+        elif options.update_description:
+            description = f'{group.name[:1].capitalize()}{group.name[1:]}' \
+                            f' - description'
+            gitlab.group_set_description(criteria, description)
+            print(f'{Colors.BOLD}   - Updated description: '
+                  f'{Colors.CYAN}{description}'
+                  f'{Colors.RESET}')
+
+        # Reset group members
+        if options.reset_members:
+            gitlab.group_reset_members(criteria)
+            print(f'{Colors.BOLD}   - Reset members: '
+                  f'{Colors.GREEN}Success'
+                  f'{Colors.RESET}')
+
+        # Set group avatar
+        if options.set_avatar:
+            gitlab.group_set_avatar(criteria, options.set_avatar)
+            print(f'{Colors.BOLD}   - Set avatar: '
+                  f'{Colors.CYAN}{options.set_avatar}'
+                  f'{Colors.RESET}')
+
+        # Footer
+        print(' ')
+        Platform.flush()

gitlab_projects_settings/package/bundle.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+
+# Bundle class, pylint: disable=too-few-public-methods
+class Bundle:
+
+    # Names
+    NAME: str = 'gitlab-projects-settings'
+
+    # Details
+    DESCRIPTION: str = 'Configure GitLab groups and projects settings automatically'
+
+    # Sources
+    REPOSITORY: str = 'https://gitlab.com/AdrianDC/gitlab-projects-settings'
+
+    # Environment
+    ENV_GITLAB_TOKEN: str = 'GITLAB_TOKEN'

gitlab_projects_settings/package/version.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from sys import version_info
+
+# Components
+from ..system.platform import Platform
+from .bundle import Bundle
+
+# Version class
+class Version:
+
+    # Getter
+    @staticmethod
+    def get() -> str:
+
+        # Acquire version from metadata
+        try:
+            from importlib import metadata # pylint: disable=import-outside-toplevel
+            return metadata.version(Bundle.NAME)
+        except Exception: # pylint: disable=broad-exception-caught # pragma: no cover
+            pass
+
+        # Acquire version from resources
+        try: # pragma: no cover
+            from pkg_resources import require # pylint: disable=import-outside-toplevel
+            name = __name__.split('.', maxsplit=1)[0]
+            return str(require(name)[0].version)
+
+        # Default fallback
+        except Exception: # pylint: disable=broad-exception-caught # pragma: no cover
+            return '0.0.0'
+
+    # Path
+    @staticmethod
+    def path() -> str:
+
+        # Acquire path
+        path = __file__
+
+        # Strip package path
+        index = path.rfind(Platform.PATH_SEPARATOR)
+        index = path.rfind(Platform.PATH_SEPARATOR, 0, index)
+        path = path[0:index]
+
+        # Result
+        return path
+
+    # Python
+    @staticmethod
+    def python() -> str:
+
+        # Acquire Python version
+        version = f'{version_info.major}.{version_info.minor}'
+
+        # Result
+        return version

gitlab_projects_settings/prints/colors.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from typing import List
+
+# Modules libraries
+try:
+    try: # colored>=2.0.0
+        from colored import Colored
+    except ImportError: # colored<2.0.0, pragma: no cover
+        from colored import colored as Colored
+except ModuleNotFoundError: # pragma: no cover
+    pass
+
+# Colors class, pylint: disable=too-few-public-methods
+class Colors:
+
+    # Attributes
+    ALL: List[str] = []
+    BOLD = ''
+    CYAN = ''
+    GREEN = ''
+    GREY = ''
+    RED = ''
+    RESET = ''
+    YELLOW = ''
+    YELLOW_LIGHT = ''
+
+    # Enabled
+    @staticmethod
+    def enabled() -> bool:
+
+        # Result
+        try:
+            return bool(Colored('').enabled())
+        except (NameError, TypeError): # pragma: no cover
+            return False
+
+    # Prepare
+    @staticmethod
+    def prepare() -> None:
+
+        # Colors enabled
+        if Colors.enabled():
+            Colors.RESET = Colored('reset').attribute()
+            Colors.BOLD = Colors.RESET + Colored('bold').attribute()
+            Colors.CYAN = Colors.BOLD + Colored('cyan').foreground()
+            Colors.GREEN = Colors.BOLD + Colored('green').foreground()
+            Colors.GREY = Colors.BOLD + Colored('light_gray').foreground()
+            Colors.RED = Colors.BOLD + Colored('red').foreground()
+            Colors.YELLOW = Colors.BOLD + Colored('yellow').foreground()
+            Colors.YELLOW_LIGHT = Colors.BOLD + Colored('light_yellow').foreground()
+            Colors.ALL = [
+                Colors.CYAN,
+                Colors.GREEN,
+                Colors.GREY,
+                Colors.RED,
+                Colors.YELLOW,
+                Colors.YELLOW_LIGHT,
+                Colors.BOLD,
+                Colors.RESET,
+            ]
+
+        # Colors disabled
+        else:
+            Colors.BOLD = ''
+            Colors.CYAN = ''
+            Colors.GREEN = ''
+            Colors.GREY = ''
+            Colors.RED = ''
+            Colors.RESET = ''
+            Colors.YELLOW = ''
+            Colors.YELLOW_LIGHT = ''
+            Colors.ALL = []
+
+    # Strip
+    @staticmethod
+    def strip(string: str) -> str:
+
+        # Strip all colors
+        for item in Colors.ALL:
+            string = string.replace(item, '')
+
+        # Result
+        return string

gitlab_projects_settings/system/platform.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from os import sep
+from sys import platform, stdin, stdout
+
+# Platform, pylint: disable=too-few-public-methods
+class Platform:
+
+    # Constants
+    IS_LINUX: bool = platform in ['linux', 'linux2']
+    IS_WINDOWS: bool = platform in ['win32', 'win64']
+
+    # Separators
+    PATH_SEPARATOR: str = sep
+
+    # TTYs
+    IS_TTY_STDIN: bool = stdin.isatty() and stdin.encoding != 'cp1252'
+    IS_TTY_STDOUT: bool = stdout.isatty()
+    IS_TTY_UTF8: bool = str(stdout.encoding).lower() == 'utf-8'
+
+    # Flush
+    @staticmethod
+    def flush() -> None:
+
+        # Flush output
+        print('', end='', flush=Platform.IS_TTY_STDOUT)

gitlab_projects_settings-1.0.0.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gitlab_projects_settings-1.0.0.dist-info/METADATA

@@ -0,0 +1,118 @@
+Metadata-Version: 2.1
+Name: gitlab-projects-settings
+Version: 1.0.0
+Summary: Migrate GitLab projects from a GitLab group to another GitLab's group
+Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
+Author: Adrian DC
+Author-email: radian.dc@gmail.com
+License: Apache License 2.0
+Project-URL: Bug Reports, https://gitlab.com/AdrianDC/gitlab-projects-settings/-/issues
+Project-URL: Changelog, https://gitlab.com/AdrianDC/gitlab-projects-settings/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://gitlab.com/AdrianDC/gitlab-projects-settings#gitlab-projects-settings
+Project-URL: Source, https://gitlab.com/AdrianDC/gitlab-projects-settings
+Project-URL: Statistics, https://pypistats.org/packages/gitlab-projects-settings
+Keywords: gitlab issues sync
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+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: Topic :: Software Development
+Classifier: Topic :: Utilities
+Requires-Python: >=3, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colored >=1.4.2
+Requires-Dist: python-gitlab >=4.4.0
+Requires-Dist: setuptools >=45.1.0
+
+# gitlab-projects-settings
+
+<!-- markdownlint-disable no-inline-html -->
+
+[![Build](https://gitlab.com/AdrianDC/gitlab-projects-settings/badges/main/pipeline.svg)](https://gitlab.com/AdrianDC/gitlab-projects-settings/-/commits/main/)
+
+Configure GitLab groups and projects settings automatically
+
+---
+
+## Purpose
+
+This tool can automatically configure and update the GitLab settings  
+of groups, subgroups and projects, using multiple available options.
+
+Repetitive tasks can be performed accross multiple projects at once,  
+for example protecting tags and branches, or setting a new avatar recursively.
+
+---
+
+## Usage
+
+<!-- prettier-ignore-start -->
+
+```yaml
+usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--avoid-group]
+                                [--avoid-subgroups] [--avoid-projects] [--reset-features]
+                                [--reset-members] [--set-avatar FILE] [--set-description TEXT]
+                                [--update-description] [--protect-branches]
+                                [--protect-tags LEVEL]
+                                [gitlab] [path]
+
+gitlab-projects-settings: Configure GitLab groups and projects settings automatically
+
+internal arguments:
+  -h, --help            # Show this help message
+  --version             # Show the current version
+
+credentials arguments:
+  -t TOKEN              # GitLab API token (default: GITLAB_TOKEN environment)
+
+common settings arguments:
+  --dry-run             # Enable dry run mode to check without saving
+  --avoid-group         # Avoid affecting parent group settings
+  --avoid-subgroups     # Avoid affecting children subgroups settings
+  --avoid-projects      # Avoid affecting children projects settings
+
+general settings arguments:
+  --reset-features      # Reset features of GitLab projects based on usage
+  --reset-members       # Reset members of GitLab projects and groups
+  --set-avatar FILE     # Set avatar of GitLab projects and groups
+  --set-description TEXT
+                        # Set description of GitLab projects and groups
+  --update-description  # Update description of GitLab projects and groups automatically
+
+repository settings arguments:
+  --protect-branches    # Protect branches with default master/main, develop and staging
+  --protect-tags LEVEL  # Protect tags at level [no-one,admins,maintainers,developers]
+
+positional arguments:
+  gitlab                # GitLab URL (default: https://gitlab.com)
+  path                  # GitLab group or project path
+```
+
+<!-- prettier-ignore-end -->
+
+---
+
+## Dependencies
+
+- [colored](https://pypi.org/project/colored/): Terminal colors and styles
+- [python-gitlab](https://pypi.org/project/python-gitlab/): A python wrapper for the GitLab API
+- [setuptools](https://pypi.org/project/setuptools/): Build and manage Python packages
+
+---
+
+## References
+
+- [git-chglog](https://github.com/git-chglog/git-chglog): CHANGELOG generator
+- [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab
+- [gitlabci-local](https://pypi.org/project/gitlabci-local/): Launch .gitlab-ci.yml jobs locally
+- [mypy](https://pypi.org/project/mypy/): Optional static typing for Python
+- [PyPI](https://pypi.org/): The Python Package Index
+- [twine](https://pypi.org/project/twine/): Utility for publishing on PyPI

gitlab_projects_settings-1.0.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+gitlab_projects_settings/__init__.py,sha256=n41iWlNc1-bRIbDPAH1L0o4nIzC-qIWpynop78EeUKA,113
+gitlab_projects_settings/__main__.py,sha256=hkYZJBCbOdKzzF558kfDUJKA_xx2TyKoOczHlTJX3ck,85
+gitlab_projects_settings/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitlab_projects_settings/cli/main.py,sha256=1cPMxkVFNKcAXoj6fTvIJGiZPFzQF1Up3FwgkhZB0JI,5331
+gitlab_projects_settings/features/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitlab_projects_settings/features/gitlab.py,sha256=o7wqQ8tCZkIZczJp3INHgq8isviNjFOcn_-VPeb-sGs,11344
+gitlab_projects_settings/features/settings.py,sha256=Cx4aoT4UaE-ejedPmaEpu1Q5143mc4dYnEXsTqa5FcE,7772
+gitlab_projects_settings/package/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitlab_projects_settings/package/bundle.py,sha256=NUdqd_YPBbXbMsxXxSBrmKtKZ0SUuwajpkZ8qaog2ng,403
+gitlab_projects_settings/package/version.py,sha256=FIPxVt1Lq9v33_McMGq6knJIPJmDhGqKY0xwJBmfnEo,1444
+gitlab_projects_settings/prints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitlab_projects_settings/prints/colors.py,sha256=vjenJ5BeGq5OSfB65mzkZpTDa7lSvVcw7AmiWnCJgFI,2262
+gitlab_projects_settings/system/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitlab_projects_settings/system/platform.py,sha256=Ktf8jGZYUCuQnRUO8s1UM8-MdTap7jEN1nI_m7tsFjE,669
+gitlab_projects_settings-1.0.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+gitlab_projects_settings-1.0.0.dist-info/METADATA,sha256=qHFW9AEiRl5Grzv517dwyU8OhAv6WD6Ot_FQ2N-nwHg,4937
+gitlab_projects_settings-1.0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+gitlab_projects_settings-1.0.0.dist-info/entry_points.txt,sha256=4u2pTghP2WldeK1wcwp3JUEDZFmkx5tx6h1yFP5QrVI,84
+gitlab_projects_settings-1.0.0.dist-info/top_level.txt,sha256=Vsj_AyqKoDdIcs8aZ-xDmOYGD3O3aS-y-mGeuUSX9k0,25
+gitlab_projects_settings-1.0.0.dist-info/RECORD,,

gitlab_projects_settings-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gitlab_projects_settings-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gitlab-projects-settings = gitlab_projects_settings.cli.main:main

gitlab_projects_settings-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gitlab_projects_settings