gitlab-projects-settings 4.1.0__tar.gz → 4.2.0__tar.gz

{gitlab_projects_settings-4.1.0 → gitlab_projects_settings-4.2.0}/CHANGELOG.md

@@ -1,4 +1,17 @@
 
+<a name="4.2.0"></a>
+## [4.2.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/4.1.0...4.2.0) (2024-05-27)
+
+### Documentation
+
+* **readme:** add 'gitlab-projects-settings' examples documentation
+
+### Features
+
+* **entrypoint:** improve outputs logs upon delections
+* **main:** show newer updates message upon incompatible arguments
+
+
 <a name="4.1.0"></a>
 ## [4.1.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/4.0.0...4.1.0) (2024-05-17)
 

{gitlab_projects_settings-4.1.0/gitlab_projects_settings.egg-info → gitlab_projects_settings-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 4.1.0
+Version: 4.2.0
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -58,6 +58,28 @@ The following step is required before using the tool:
 
 ---
 
+## Examples
+
+<!-- prettier-ignore-start -->
+
+```bash
+# Show the helper menu
+gitlab-projects-settings
+
+# Protect all projects' tags under a group
+gitlab-projects-settings --protect-tags -- 'https://gitlab.com' 'group'
+
+# Update all avatars and descriptions under a group
+gitlab-projects-settings --set-avatar ./avatar.png --update-description 'https://gitlab.com' 'group'
+
+# Automatically detect and reset features of projects based on usage
+gitlab-projects-settings --reset-features 'https://gitlab.com' 'group/project'
+```
+
+<!-- prettier-ignore-end -->
+
+---
+
 ## Usage
 
 <!-- prettier-ignore-start -->
@@ -65,7 +87,7 @@ The following step is required before using the tool:
 
 ```yaml
 usage: gitlab-projects-settings [-h] [--version] [--update-check] [--settings] [--set GROUP KEY VAL] [-t TOKEN]
-                                [--dry-run] [--exclude-group] [--exclude-subgroups] [--exclude-projects]
+                                [--dry-run] [--dump] [--exclude-group] [--exclude-subgroups] [--exclude-projects]
                                 [--available-features] [--reset-features [KEEP_FEATURES]]
                                 [--disable-features FEATURES] [--enable-features FEATURES] [--reset-members]
                                 [--set-avatar FILE] [--set-description TEXT] [--update-description]
@@ -88,6 +110,7 @@ credentials arguments:
 
 common settings arguments:
   --dry-run                         # Enable dry run mode to check without saving
+  --dump                            # Dump Python objects of groups and projects
   --exclude-group                   # Exclude parent group settings
   --exclude-subgroups               # Exclude children subgroups settings
   --exclude-projects                # Exclude children projects settings

{gitlab_projects_settings-4.1.0 → gitlab_projects_settings-4.2.0}/README.md

@@ -22,6 +22,28 @@ The following step is required before using the tool:
 
 ---
 
+## Examples
+
+<!-- prettier-ignore-start -->
+
+```bash
+# Show the helper menu
+gitlab-projects-settings
+
+# Protect all projects' tags under a group
+gitlab-projects-settings --protect-tags -- 'https://gitlab.com' 'group'
+
+# Update all avatars and descriptions under a group
+gitlab-projects-settings --set-avatar ./avatar.png --update-description 'https://gitlab.com' 'group'
+
+# Automatically detect and reset features of projects based on usage
+gitlab-projects-settings --reset-features 'https://gitlab.com' 'group/project'
+```
+
+<!-- prettier-ignore-end -->
+
+---
+
 ## Usage
 
 <!-- prettier-ignore-start -->
@@ -29,7 +51,7 @@ The following step is required before using the tool:
 
 ```yaml
 usage: gitlab-projects-settings [-h] [--version] [--update-check] [--settings] [--set GROUP KEY VAL] [-t TOKEN]
-                                [--dry-run] [--exclude-group] [--exclude-subgroups] [--exclude-projects]
+                                [--dry-run] [--dump] [--exclude-group] [--exclude-subgroups] [--exclude-projects]
                                 [--available-features] [--reset-features [KEEP_FEATURES]]
                                 [--disable-features FEATURES] [--enable-features FEATURES] [--reset-members]
                                 [--set-avatar FILE] [--set-description TEXT] [--update-description]
@@ -52,6 +74,7 @@ credentials arguments:
 
 common settings arguments:
   --dry-run                         # Enable dry run mode to check without saving
+  --dump                            # Dump Python objects of groups and projects
   --exclude-group                   # Exclude parent group settings
   --exclude-subgroups               # Exclude children subgroups settings
   --exclude-projects                # Exclude children projects settings

{gitlab_projects_settings-4.1.0 → gitlab_projects_settings-4.2.0/gitlab_projects_settings.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 4.1.0
+Version: 4.2.0
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -58,6 +58,28 @@ The following step is required before using the tool:
 
 ---
 
+## Examples
+
+<!-- prettier-ignore-start -->
+
+```bash
+# Show the helper menu
+gitlab-projects-settings
+
+# Protect all projects' tags under a group
+gitlab-projects-settings --protect-tags -- 'https://gitlab.com' 'group'
+
+# Update all avatars and descriptions under a group
+gitlab-projects-settings --set-avatar ./avatar.png --update-description 'https://gitlab.com' 'group'
+
+# Automatically detect and reset features of projects based on usage
+gitlab-projects-settings --reset-features 'https://gitlab.com' 'group/project'
+```
+
+<!-- prettier-ignore-end -->
+
+---
+
 ## Usage
 
 <!-- prettier-ignore-start -->
@@ -65,7 +87,7 @@ The following step is required before using the tool:
 
 ```yaml
 usage: gitlab-projects-settings [-h] [--version] [--update-check] [--settings] [--set GROUP KEY VAL] [-t TOKEN]
-                                [--dry-run] [--exclude-group] [--exclude-subgroups] [--exclude-projects]
+                                [--dry-run] [--dump] [--exclude-group] [--exclude-subgroups] [--exclude-projects]
                                 [--available-features] [--reset-features [KEEP_FEATURES]]
                                 [--disable-features FEATURES] [--enable-features FEATURES] [--reset-members]
                                 [--set-avatar FILE] [--set-description TEXT] [--update-description]
@@ -88,6 +110,7 @@ credentials arguments:
 
 common settings arguments:
   --dry-run                         # Enable dry run mode to check without saving
+  --dump                            # Dump Python objects of groups and projects
   --exclude-group                   # Exclude parent group settings
   --exclude-subgroups               # Exclude children subgroups settings
   --exclude-projects                # Exclude children projects settings

{gitlab_projects_settings-4.1.0 → gitlab_projects_settings-4.2.0}/src/cli/entrypoint.py

@@ -25,7 +25,7 @@ from ..types.namespaces import Namespaces
 class Entrypoint:
 
     # Enumerations
-    Result = Enum('Result', ['SUCCESS', 'FINALIZE', 'ERROR'])
+    Result = Enum('Result', ['SUCCESS', 'FINALIZE', 'ERROR', 'CRITICAL'])
 
     # CLI, pylint: disable=too-many-branches
     @staticmethod
@@ -237,6 +237,8 @@ class Entrypoint:
                     group_type,
                     group.full_path,
             ):
+                print(' ')
+                Platform.flush()
                 return Entrypoint.Result.SUCCESS
 
             # Delete group
@@ -297,6 +299,11 @@ class Entrypoint:
                   f'{Colors.RESET}')
             Platform.flush()
 
+        # Dump group object
+        if options.dump:
+            print(' ')
+            print(group.to_json())
+
         # Footer
         print(' ')
         Platform.flush()
@@ -328,6 +335,8 @@ class Entrypoint:
                     'project',
                     project.path_with_namespace,
             ):
+                print(' ')
+                Platform.flush()
                 return Entrypoint.Result.SUCCESS
 
             # Delete project
@@ -497,6 +506,11 @@ class Entrypoint:
                       f'{Colors.RESET}')
                 Platform.flush()
 
+        # Dump group object
+        if options.dump:
+            print(' ')
+            print(project.to_json())
+
         # Footer
         print(' ')
         Platform.flush()

{gitlab_projects_settings-4.1.0 → gitlab_projects_settings-4.2.0}/src/cli/main.py

@@ -94,6 +94,12 @@ def main() -> None:
         action='store_true',
         help='Enable dry run mode to check without saving',
     )
+    group.add_argument(
+        '--dump',
+        dest='dump',
+        action='store_true',
+        help='Dump Python objects of groups and projects',
+    )
     group.add_argument(
         '--exclude-group',
         dest='exclude_group',
@@ -292,18 +298,19 @@ def main() -> None:
 
     # Arguments validation
     if not options.token or not options.gitlab or not options.path:
-        print(' ')
-        parser.print_help()
-        print(' ')
-        Platform.flush()
-        sys_exit(1)
+        result = Entrypoint.Result.CRITICAL
 
     # Header
     print(' ')
     Platform.flush()
 
     # CLI entrypoint
-    result = Entrypoint.cli(options)
+    if result != Entrypoint.Result.CRITICAL:
+        result = Entrypoint.cli(options)
+
+    # CLI helper
+    else:
+        parser.print_help()
 
     # Footer
     print(' ')