gitlab-projects-settings 1.0.1__tar.gz → 1.1.0__tar.gz

{gitlab_projects_settings-1.0.1 → gitlab_projects_settings-1.1.0}/CHANGELOG.md

@@ -1,4 +1,16 @@
 
+<a name="1.1.0"></a>
+## [1.1.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/1.0.1...1.1.0) (2024-04-25)
+
+### Code Refactoring
+
+* **settings:** minor functions codestyle improvement
+
+### Features
+
+* **main:** rename '--avoid-*' parameters to '--exclude-*'
+
+
 <a name="1.0.1"></a>
 ## [1.0.1](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/1.0.0...1.0.1) (2024-04-24)
 

{gitlab_projects_settings-1.0.1 → gitlab_projects_settings-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 1.0.1
+Version: 1.1.0
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -57,8 +57,8 @@ for example protecting tags and branches, or setting a new avatar recursively.
 <!-- prettier-ignore-start -->
 
 ```yaml
-usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--avoid-group]
-                                [--avoid-subgroups] [--avoid-projects] [--reset-features]
+usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--exclude-group]
+                                [--exclude-subgroups] [--exclude-projects] [--reset-features]
                                 [--reset-members] [--set-avatar FILE] [--set-description TEXT]
                                 [--update-description] [--protect-branches]
                                 [--protect-tags LEVEL]
@@ -75,9 +75,9 @@ credentials arguments:
 
 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
+  --exclude-group       # Exclude parent group settings
+  --exclude-subgroups   # Exclude children subgroups settings
+  --exclude-projects    # Exclude children projects settings
 
 general settings arguments:
   --reset-features      # Reset features of GitLab projects based on usage

{gitlab_projects_settings-1.0.1 → gitlab_projects_settings-1.1.0}/README.md

@@ -23,8 +23,8 @@ for example protecting tags and branches, or setting a new avatar recursively.
 <!-- prettier-ignore-start -->
 
 ```yaml
-usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--avoid-group]
-                                [--avoid-subgroups] [--avoid-projects] [--reset-features]
+usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--exclude-group]
+                                [--exclude-subgroups] [--exclude-projects] [--reset-features]
                                 [--reset-members] [--set-avatar FILE] [--set-description TEXT]
                                 [--update-description] [--protect-branches]
                                 [--protect-tags LEVEL]
@@ -41,9 +41,9 @@ credentials arguments:
 
 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
+  --exclude-group       # Exclude parent group settings
+  --exclude-subgroups   # Exclude children subgroups settings
+  --exclude-projects    # Exclude children projects settings
 
 general settings arguments:
   --reset-features      # Reset features of GitLab projects based on usage

{gitlab_projects_settings-1.0.1 → gitlab_projects_settings-1.1.0}/gitlab_projects_settings/cli/main.py

@@ -61,22 +61,22 @@ def main() -> None:
         help='Enable dry run mode to check without saving',
     )
     group.add_argument(
-        '--avoid-group',
-        dest='avoid_group',
+        '--exclude-group',
+        dest='exclude_group',
         action='store_true',
-        help='Avoid affecting parent group settings',
+        help='Exclude parent group settings',
     )
     group.add_argument(
-        '--avoid-subgroups',
-        dest='avoid_subgroups',
+        '--exclude-subgroups',
+        dest='exclude_subgroups',
         action='store_true',
-        help='Avoid affecting children subgroups settings',
+        help='Exclude children subgroups settings',
     )
     group.add_argument(
-        '--avoid-projects',
-        dest='avoid_projects',
+        '--exclude-projects',
+        dest='exclude_projects',
         action='store_true',
-        help='Avoid affecting children projects settings',
+        help='Exclude children projects settings',
     )
 
     # Arguments general settings definitions

{gitlab_projects_settings-1.0.1 → gitlab_projects_settings-1.1.0}/gitlab_projects_settings/features/settings.py

@@ -57,11 +57,11 @@ class SettingsFeature:
         elif group:
 
             # Handle group
-            if not options.avoid_group:
+            if not options.exclude_group:
                 SettingsFeature.group(options, gitlab, group.id)
 
             # Iterate through subgroups
-            if not options.avoid_subgroups:
+            if not options.exclude_subgroups:
                 for group_subgroup in group.descendant_groups.list(
                         get_all=True,
                         include_subgroups=True,
@@ -71,10 +71,10 @@ class SettingsFeature:
                     SettingsFeature.group(options, gitlab, group_subgroup.id)
 
             # Iterate through projects
-            if not options.avoid_projects:
+            if not options.exclude_projects:
                 for group_project in group.projects.list(
                         get_all=True,
-                        include_subgroups=not options.avoid_subgroups,
+                        include_subgroups=not options.exclude_subgroups,
                         order_by='path',
                         sort='asc',
                 ):
@@ -83,12 +83,71 @@ class SettingsFeature:
         # Result
         return True
 
-    # GitLab projects settings project, pylint: disable=too-many-branches
+    # Group
     @staticmethod
-    def project(options: Namespace, gitlab: GitLabFeature, criteria: str) -> None:
+    def group(
+        options: Namespace,
+        gitlab: GitLabFeature,
+        criteria: str,
+        subgroup: bool = False,
+    ) -> None:
+
+        # Acquire group
+        group = gitlab.group(criteria)
 
-        # Show project details
+        # Show group details
+        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()
+
+    # Project, pylint: disable=too-many-branches
+    @staticmethod
+    def project(
+        options: Namespace,
+        gitlab: GitLabFeature,
+        criteria: str,
+    ) -> None:
+
+        # Acquire project
         project = gitlab.project(criteria)
+
+        # Show project details
         print(f'{Colors.BOLD} - GitLab project: '
               f'{Colors.YELLOW_LIGHT}{project.path_with_namespace} '
               f'{Colors.CYAN}({project.description})'
@@ -164,50 +223,3 @@ class SettingsFeature:
         # 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-1.0.1 → gitlab_projects_settings-1.1.0}/gitlab_projects_settings.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 1.0.1
+Version: 1.1.0
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -57,8 +57,8 @@ for example protecting tags and branches, or setting a new avatar recursively.
 <!-- prettier-ignore-start -->
 
 ```yaml
-usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--avoid-group]
-                                [--avoid-subgroups] [--avoid-projects] [--reset-features]
+usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--exclude-group]
+                                [--exclude-subgroups] [--exclude-projects] [--reset-features]
                                 [--reset-members] [--set-avatar FILE] [--set-description TEXT]
                                 [--update-description] [--protect-branches]
                                 [--protect-tags LEVEL]
@@ -75,9 +75,9 @@ credentials arguments:
 
 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
+  --exclude-group       # Exclude parent group settings
+  --exclude-subgroups   # Exclude children subgroups settings
+  --exclude-projects    # Exclude children projects settings
 
 general settings arguments:
   --reset-features      # Reset features of GitLab projects based on usage