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

{gitlab_projects_settings-3.0.0 → gitlab_projects_settings-4.1.0}/.gitlab-ci.yml

@@ -1,11 +1,14 @@
-image: registry.gitlab.com/adriandc/gitlabci-local/python:3.11-alpine
-
 stages:
   - development
   - prepare
   - build
   - deploy
 
+variables:
+  REGISTRY_HOST: registry.gitlab.com
+  REGISTRY_OWNER: adriandc
+  REGISTRY_PROJECT: gitlab-projects-settings
+
 .local:
   engine: docker,auto
   real_paths: true
@@ -53,12 +56,113 @@ changelog:
   rules:
     - if: $CI_LOCAL
 
+images:
+  stage: development
+  image: local:silent
+  script:
+    # Rehost standard images
+    - |
+      for image in \
+          python:3.11-alpine \
+      ; do
+        if [ -z "${IMAGE}" ] || echo "${image}" | grep -q "${IMAGE}"; then
+          echo ''
+          echo " [INFO] Pull: ${image}"
+          echo ''
+          docker pull "${image}"
+          docker tag "${image}" "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+          echo ''
+          echo " [INFO] Push: ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+          echo ''
+          docker push "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+          docker rmi "${image}" >/dev/null || true
+        fi
+      done
+    # Prepare build image
+    - |
+      base='python:3.11-alpine'
+      image='gitlab-projects-settings:build'
+      if [ -z "${IMAGE}" ] || echo "${image}" | grep -q "${IMAGE}"; then
+        echo ''
+        echo " [INFO] Pull: ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}"
+        echo ''
+        docker pull "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}"
+        docker pull "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}" || true
+        docker build -t "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}" -f - . <<-EOF
+      FROM ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}
+      RUN apk add -q git
+      COPY ./requirements/runtime.txt /tmp/
+      COPY ./requirements/build.txt /tmp/
+      RUN export PIP_DISABLE_PIP_VERSION_CHECK=1 \
+       && pip3 install -q -r /tmp/runtime.txt --no-cache-dir --upgrade \
+       && pip3 install -q -r /tmp/build.txt --no-cache-dir --upgrade \
+       && rm -f /tmp/runtime.txt \
+       && rm -f /tmp/build.txt
+      EOF
+        echo ''
+        echo " [INFO] Push: ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+        echo ''
+        docker push "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+      fi
+    # Prepare codestyle image
+    - |
+      base='python:3.11-alpine'
+      image='gitlab-projects-settings:codestyle'
+      if [ -z "${IMAGE}" ] || echo "${image}" | grep -q "${IMAGE}"; then
+        echo ''
+        echo " [INFO] Pull: ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}"
+        echo ''
+        docker pull "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}"
+        docker pull "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}" || true
+        docker build -t "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}" -f- . <<-EOF
+      FROM ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}
+      RUN apk add -q git
+      COPY ./requirements/runtime.txt /tmp/
+      COPY ./requirements/quality.txt /tmp/
+      RUN export PIP_DISABLE_PIP_VERSION_CHECK=1 \
+       && pip3 install -q -r /tmp/runtime.txt --no-cache-dir --upgrade \
+       && pip3 install -q -r /tmp/quality.txt --no-cache-dir --upgrade \
+       && rm -f /tmp/runtime.txt \
+       && rm -f /tmp/quality.txt \
+       && rm -f /tmp/tests.txt
+      EOF
+        echo ''
+        echo " [INFO] Push: ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+        echo ''
+        docker push "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+      fi
+    # Prepare deploy image
+    - |
+      base='python:3.11-alpine'
+      image='gitlab-projects-settings:deploy'
+      if [ -z "${IMAGE}" ] || echo "${image}" | grep -q "${IMAGE}"; then
+        echo ''
+        echo " [INFO] Pull: ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}"
+        echo ''
+        docker pull "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}"
+        docker pull "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}" || true
+        docker build -t "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}" -f - . <<-EOF
+      FROM ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${base}
+      RUN apk add -q gcc git libc-dev libffi-dev sed
+      COPY ./requirements/deploy.txt /tmp/
+      RUN export PIP_DISABLE_PIP_VERSION_CHECK=1 \
+       && pip3 install -q -r /tmp/deploy.txt --no-cache-dir --upgrade \
+       && rm -f /tmp/deploy.txt
+      EOF
+        echo ''
+        echo " [INFO] Push: ${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+        echo ''
+        docker push "${REGISTRY_HOST}/${REGISTRY_OWNER}/${REGISTRY_PROJECT}/${image}"
+      fi
+  rules:
+    - if: $CI_LOCAL
+
 # =============================================================================
 # Stage: prepare
 
 codestyle:
   stage: prepare
-  image: registry.gitlab.com/adriandc/gitlabci-local/gitlabci-local:codestyle
+  image: registry.gitlab.com/adriandc/gitlab-projects-settings/gitlab-projects-settings:codestyle
   script:
     - yapf -i ./src/*.py ./src/*/*.py ./setup.py
     - unify -i --quote "'" ./src/*.py ./src/*/*.py ./setup.py
@@ -77,11 +181,7 @@ codestyle:
 
 lint:
   stage: prepare
-  image: registry.gitlab.com/adriandc/gitlabci-local/gitlabci-local:codestyle
-  variables:
-    PIP_DISABLE_PIP_VERSION_CHECK: 1
-  before_script:
-    - pip3 install -q -r ./requirements/runtime.txt --upgrade
+  image: registry.gitlab.com/adriandc/gitlab-projects-settings/gitlab-projects-settings:codestyle
   script:
     - pylint --errors-only ./src/ ./setup.py
     - pylint --disable=missing-docstring --load-plugins=pylint.extensions.no_self_use ./src/ ./setup.py
@@ -98,7 +198,7 @@ lint:
 
 typings:
   stage: prepare
-  image: registry.gitlab.com/adriandc/gitlabci-local/gitlabci-local:codestyle
+  image: registry.gitlab.com/adriandc/gitlab-projects-settings/gitlab-projects-settings:codestyle
   variables:
     MYPY_CACHE_DIR: /dev/null
     MYPY_FORCE_COLOR: 1
@@ -127,7 +227,7 @@ typings:
 
 build:
   stage: build
-  image: registry.gitlab.com/adriandc/gitlabci-local/gitlabci-local:build
+  image: registry.gitlab.com/adriandc/gitlab-projects-settings/gitlab-projects-settings:build
   needs: []
   script:
     - rm -rf ./build ./dist ./*.egg-info ./.eggs
@@ -170,13 +270,18 @@ readme:
         argument='[[:alnum:]][[:alnum:]_-]\{0,\}'
         letter='[[:alnum:]_]\{1\}'
         parameter='[-]\{1,2\}[[:alnum:]][[:alnum:]_-]\{0,\}'
+        separator='--'
         word='[[:alnum:]_-]\{1,\}'
+        help="[(]\{0,1\}${word}"
         "${PACKAGE_NAME}" --help \
           | sed '1d; $d' \
-          | sed "s/^\(  ${parameter} ${word}${alignments}\)/\1# /g" \
+          | sed "s/^\(  ${parameter} \[${word}\]${alignments}\)/\1# /g" \
+          | sed "s/^\(  ${parameter}\( ${word}\)\{1,\}${alignments}\)/\1# /g" \
           | sed "s/^\(  ${parameter}${alignments}\)/\1# /g" \
           | sed "s/^\(  ${parameter}, ${parameter}${alignments}\)/\1# /g" \
-          | sed "s/^\(  ${argument}${alignments}\)/\1# /g"
+          | sed "s/^\(  ${separator}${alignments}\)/\1# /g" \
+          | sed "s/^\(  ${argument}${alignments}\)/\1# /g" \
+          | sed "s/^\(  ${alignments}\)\(${help}\)/\1# \2/g"
         echo '```'
         echo ''
       } >./.tmp/README.help.tmp
@@ -189,6 +294,7 @@ readme:
     - |
       git -c color.diff=always --no-pager diff ./README.md | grep --color=never '.' && echo ''
       echo  ' > README: Updated successfully'
+      git diff --quiet ./README.md
   rules:
     - if: $CI_LOCAL
 
@@ -197,7 +303,7 @@ readme:
 
 deploy:release:
   stage: deploy
-  image: registry.gitlab.com/adriandc/gitlabci-local/gitlabci-local:deploy
+  image: registry.gitlab.com/adriandc/gitlab-projects-settings/gitlab-projects-settings:deploy
   needs:
     - job: build
   variables:
@@ -215,7 +321,7 @@ deploy:release:
 
 deploy:trial:
   stage: deploy
-  image: registry.gitlab.com/adriandc/gitlabci-local/gitlabci-local:deploy
+  image: registry.gitlab.com/adriandc/gitlab-projects-settings/gitlab-projects-settings:deploy
   needs:
     - job: build
   variables:

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

@@ -1,4 +1,57 @@
 
+<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)
+
+### Features
+
+* **entrypoint:** implement prompt confirmation upon deletions
+* **gitlab:** isolate 'ProtectionLevels' enumeration
+* **requirements:** prepare 'questionary' library integration
+
+
+<a name="4.0.0"></a>
+## [4.0.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/3.0.0...4.0.0) (2024-05-15)
+
+### Bug Fixes
+
+* **entrypoint:** refactor to return no error upon final actions
+* **entrypoint:** avoid missing 'namespace_id' in 'User' responses
+* **entrypoint:** use full paths instead of 'id' integer fields
+* **gitlab:** disable all 'Repository' member features too
+* **gitlab:** disable 'Repository' group feature after its members
+* **gitlab:** accept deletion denials in 'project_reset_members'
+
+### Ci
+
+* **gitlab-ci:** support multiple 'METAVAR' words in 'readme' job
+* **gitlab-ci:** deprecate requirements install in 'lint' job
+* **gitlab-ci:** implement 'images' and use project specific images
+* **gitlab-ci:** detect 'README.md' issues in 'readme' job
+* **gitlab-ci:** handle optional parameters and multiline in 'readme'
+
+### Cleanups
+
+* **entrypoint:** minor Python codestyle improvement
+
+### Code Refactoring
+
+* **gitlab:** optimize and centralize GitLab features handlings
+* **gitlab:** isolate GitLab types to 'types/gitlab.py'
+* **gitlab:** isolate 'GitLabFeature.AccessLevels' constants
+
+### Features
+
+* **gitlab:** parse input features list and accept similar texts
+* **gitlab:** prepare future access levels in 'project_reset_features'
+* **gitlab:** isolate GitLab project features enumeration
+* **gitlab:** automatically wait for group and project deletions
+* **main:** document optional '--' positional arguments separator
+
+### Test
+
+* **version:** add 'DEBUG_VERSION_FAKE' for debugging purposes
+
+
 <a name="3.0.0"></a>
 ## [3.0.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/2.1.0...3.0.0) (2024-05-06)
 

gitlab_projects_settings-4.1.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.1
+Name: gitlab-projects-settings
+Version: 4.1.0
+Summary: Configure GitLab groups and projects settings automatically
+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: questionary>=2.0.1
+Requires-Dist: setuptools>=45.1.0
+Requires-Dist: update_checker>=0.18.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.
+
+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
+
+<!-- prettier-ignore-start -->
+<!-- readme-help-start -->
+
+```yaml
+usage: gitlab-projects-settings [-h] [--version] [--update-check] [--settings] [--set GROUP KEY VAL] [-t TOKEN]
+                                [--dry-run] [--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]
+                                [--run-housekeeping] [--archive-project | --unarchive-project] [--delete-group]
+                                [--delete-project] [--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
+  --update-check                    # Check for newer package updates
+  --settings                        # Show the current settings path and contents
+  --set GROUP KEY VAL               # Set settings specific 'VAL' value to [GROUP] > KEY
+                                    # or unset by using 'UNSET' as 'VAL'
+
+credentials arguments:
+  -t TOKEN                          # GitLab API token (default: GITLAB_TOKEN environment)
+
+common settings arguments:
+  --dry-run                         # Enable dry run mode to check without saving
+  --exclude-group                   # Exclude parent group settings
+  --exclude-subgroups               # Exclude children subgroups settings
+  --exclude-projects                # Exclude children projects settings
+
+general settings arguments:
+  --available-features              # List the available GitLab project features known by the tool
+  --reset-features [KEEP_FEATURES]  # Reset features of GitLab projects based on usage
+                                    # (Optionally keep features separated by ",")
+  --disable-features FEATURES       # List of features to disable separated by ","
+  --enable-features FEATURES        # List of features to enable separated by ","
+  --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
+
+advanced settings arguments:
+  --run-housekeeping                # Run housekeeping of project or projects GitLab in groups
+  --archive-project                 # Archive project or projects in GitLab groups
+  --unarchive-project               # Unarchive project or projects in GitLab groups
+  --delete-group                    # Delete group or groups in GitLab groups
+  --delete-project                  # Delete project or projects in GitLab groups
+
+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] (default: no-one)
+
+positional arguments:
+  --                                # Positional arguments separator (recommended)
+  gitlab                            # GitLab URL (default: https://gitlab.com)
+  path                              # GitLab group, user namespace or project path
+```
+
+<!-- readme-help-stop -->
+<!-- prettier-ignore-end -->
+
+---
+
+## Userspace available settings
+
+`gitlab-projects-settings` creates a `settings.ini` configuration file in a userspace folder.
+
+For example, it allows to disable the automated updates daily check (`[updates] > enabled`)
+
+The `settings.ini` file location and contents can be shown with the following command:
+
+```bash
+gitlab-projects-settings --settings
+```
+
+---
+
+## Environment available configurations
+
+`gitlab-projects-settings` uses `colored` for colors outputs and `questionary` for interactive menus.
+
+If colors of both outputs types do not match the terminal's theme,  
+an environment variable `NO_COLOR=1` can be defined to disable colors.
+
+---
+
+## 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
+- [questionary](https://pypi.org/project/questionary/): Interactive terminal user interfaces
+- [setuptools](https://pypi.org/project/setuptools/): Build and manage Python packages
+- [update-checker](https://pypi.org/project/update-checker/): Check for package updates on PyPI
+
+---
+
+## 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-4.1.0/README.md

@@ -0,0 +1,132 @@
+# 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.
+
+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
+
+<!-- prettier-ignore-start -->
+<!-- readme-help-start -->
+
+```yaml
+usage: gitlab-projects-settings [-h] [--version] [--update-check] [--settings] [--set GROUP KEY VAL] [-t TOKEN]
+                                [--dry-run] [--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]
+                                [--run-housekeeping] [--archive-project | --unarchive-project] [--delete-group]
+                                [--delete-project] [--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
+  --update-check                    # Check for newer package updates
+  --settings                        # Show the current settings path and contents
+  --set GROUP KEY VAL               # Set settings specific 'VAL' value to [GROUP] > KEY
+                                    # or unset by using 'UNSET' as 'VAL'
+
+credentials arguments:
+  -t TOKEN                          # GitLab API token (default: GITLAB_TOKEN environment)
+
+common settings arguments:
+  --dry-run                         # Enable dry run mode to check without saving
+  --exclude-group                   # Exclude parent group settings
+  --exclude-subgroups               # Exclude children subgroups settings
+  --exclude-projects                # Exclude children projects settings
+
+general settings arguments:
+  --available-features              # List the available GitLab project features known by the tool
+  --reset-features [KEEP_FEATURES]  # Reset features of GitLab projects based on usage
+                                    # (Optionally keep features separated by ",")
+  --disable-features FEATURES       # List of features to disable separated by ","
+  --enable-features FEATURES        # List of features to enable separated by ","
+  --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
+
+advanced settings arguments:
+  --run-housekeeping                # Run housekeeping of project or projects GitLab in groups
+  --archive-project                 # Archive project or projects in GitLab groups
+  --unarchive-project               # Unarchive project or projects in GitLab groups
+  --delete-group                    # Delete group or groups in GitLab groups
+  --delete-project                  # Delete project or projects in GitLab groups
+
+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] (default: no-one)
+
+positional arguments:
+  --                                # Positional arguments separator (recommended)
+  gitlab                            # GitLab URL (default: https://gitlab.com)
+  path                              # GitLab group, user namespace or project path
+```
+
+<!-- readme-help-stop -->
+<!-- prettier-ignore-end -->
+
+---
+
+## Userspace available settings
+
+`gitlab-projects-settings` creates a `settings.ini` configuration file in a userspace folder.
+
+For example, it allows to disable the automated updates daily check (`[updates] > enabled`)
+
+The `settings.ini` file location and contents can be shown with the following command:
+
+```bash
+gitlab-projects-settings --settings
+```
+
+---
+
+## Environment available configurations
+
+`gitlab-projects-settings` uses `colored` for colors outputs and `questionary` for interactive menus.
+
+If colors of both outputs types do not match the terminal's theme,  
+an environment variable `NO_COLOR=1` can be defined to disable colors.
+
+---
+
+## 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
+- [questionary](https://pypi.org/project/questionary/): Interactive terminal user interfaces
+- [setuptools](https://pypi.org/project/setuptools/): Build and manage Python packages
+- [update-checker](https://pypi.org/project/update-checker/): Check for package updates on PyPI
+
+---
+
+## 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