gitlab-projects-settings 2.0.0__tar.gz → 2.0.2__tar.gz

{gitlab_projects_settings-2.0.0 → gitlab_projects_settings-2.0.2}/.gitlab-ci.yml

@@ -137,6 +137,7 @@ typings:
   stage: prepare
   image: registry.gitlab.com/adriandc/gitlabci-local/gitlabci-local:codestyle
   variables:
+    MYPY_CACHE_DIR: /dev/null
     MYPY_FORCE_COLOR: 1
     TERM: ansi
   script:

{gitlab_projects_settings-2.0.0 → gitlab_projects_settings-2.0.2}/CHANGELOG.md

@@ -1,4 +1,28 @@
 
+<a name="2.0.2"></a>
+## [2.0.2](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/2.0.1...2.0.2) (2024-04-28)
+
+### Ci
+
+* **gitlab-ci:** disable 'typing' mypy caching with 'MYPY_CACHE_DIR'
+
+### Documentation
+
+* **readme:** document GitLab tokens' creation instructions
+
+### Features
+
+* **main:** limit '--help' width to terminal width or 120 chars
+
+
+<a name="2.0.1"></a>
+## [2.0.1](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/2.0.0...2.0.1) (2024-04-28)
+
+### Bug Fixes
+
+* **entrypoint:** fix description updates faulty descriptions
+
+
 <a name="2.0.0"></a>
 ## [2.0.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/1.1.0...2.0.0) (2024-04-27)
 

{gitlab_projects_settings-2.0.0 → gitlab_projects_settings-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 2.0.0
+Version: 2.0.2
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -50,6 +50,10 @@ 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.
 
+The following step is required before using the tool:
+
+- The GitLab user tokens must be created with an `api` scope (a short expiration date is recommended)
+
 ---
 
 ## Usage

{gitlab_projects_settings-2.0.0 → gitlab_projects_settings-2.0.2}/README.md

@@ -16,6 +16,10 @@ 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.
 
+The following step is required before using the tool:
+
+- The GitLab user tokens must be created with an `api` scope (a short expiration date is recommended)
+
 ---
 
 ## Usage

{gitlab_projects_settings-2.0.0 → gitlab_projects_settings-2.0.2}/gitlab_projects_settings.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 2.0.0
+Version: 2.0.2
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -50,6 +50,10 @@ 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.
 
+The following step is required before using the tool:
+
+- The GitLab user tokens must be created with an `api` scope (a short expiration date is recommended)
+
 ---
 
 ## Usage

{gitlab_projects_settings-2.0.0 → gitlab_projects_settings-2.0.2}/src/cli/entrypoint.py

@@ -118,6 +118,18 @@ class Entrypoint:
         # Acquire group
         group = gitlab.group(criteria)
 
+        # Acquire parent group
+        parent_group: Group = None
+        if group.parent_id:
+            parent_group = gitlab.group(group.parent_id)
+
+        # Get parent description
+        parent_description: str = ''
+        parent_name: str = ''
+        if parent_group:
+            parent_description = parent_group.description
+            parent_name = parent_group.name
+
         # Show group details
         group_type = 'subgroup' if subgroup else 'group'
         print(f'{Colors.BOLD} - GitLab {group_type}: '
@@ -134,8 +146,14 @@ class Entrypoint:
 
         # Update group description
         elif options.update_description:
-            description = f'{group.name[:1].capitalize()}{group.name[1:]}' \
-                          f' - description'
+            parent_description_text: str = ''
+            if parent_name:
+                parent_description_text = ' - ' + GitLabFeature.Helper.describe(
+                    parent_description,
+                    parent_name,
+                )
+            description = f'{GitLabFeature.Helper.capitalize(group.name)}' \
+                          f'{parent_description_text}'
             gitlab.group_set_description(criteria, description)
             print(f'{Colors.BOLD}   - Updated description: '
                   f'{Colors.CYAN}{description}'
@@ -170,6 +188,9 @@ class Entrypoint:
         # Acquire project
         project = gitlab.project(criteria)
 
+        # Acquire group
+        group = gitlab.group(project.namespace['id'])
+
         # Show project details
         print(f'{Colors.BOLD} - GitLab project: '
               f'{Colors.YELLOW_LIGHT}{project.path_with_namespace} '
@@ -185,11 +206,15 @@ class Entrypoint:
 
         # Update project description
         elif options.update_description:
-            description = f'{project.name[:1].capitalize()}{project.name[1:]}' \
-                            f' - description'
+            group_description = GitLabFeature.Helper.describe(
+                group.description,
+                group.name,
+            )
+            description = f'{GitLabFeature.Helper.capitalize(project.name)}' \
+                          f' - {group_description}'
             gitlab.project_set_description(criteria, description)
             print(f'{Colors.BOLD}   - Updated description: '
-                  f'{Colors.CYAN}{description}'
+                  f'{Colors.CYAN}{group_description}'
                   f'{Colors.RESET}')
 
         # Reset project features

{gitlab_projects_settings-2.0.0 → gitlab_projects_settings-2.0.2}/src/cli/main.py

@@ -3,6 +3,7 @@
 # Standard libraries
 from argparse import (_ArgumentGroup, ArgumentParser, Namespace, RawTextHelpFormatter)
 from os import environ
+from shutil import get_terminal_size
 from sys import exit as sys_exit
 
 # Components
@@ -27,6 +28,10 @@ def main() -> None:
         formatter_class=lambda prog: RawTextHelpFormatter(
             prog,
             max_help_position=30,
+            width=min(
+                120,
+                get_terminal_size().columns - 2,
+            ),
         ),
     )
 

{gitlab_projects_settings-2.0.0 → gitlab_projects_settings-2.0.2}/src/features/gitlab.py

@@ -317,3 +317,21 @@ class GitLabFeature:
     @property
     def url(self) -> str:
         return str(self.__gitlab.api_url)
+
+    # Helper class
+    class Helper:
+
+        # Capitalize
+        @staticmethod
+        def capitalize(text: str) -> str:
+            return f'{text[:1].capitalize()}{text[1:]}'
+
+        # Describe
+        @staticmethod
+        def describe(
+            description: str,
+            name: str,
+        ) -> str:
+            if description:
+                return description
+            return GitLabFeature.Helper.capitalize(name)