feat: adding constants

Author: RobPasMue

src/ansys/tools/repo_sync/__init__.py

@@ -31,4 +31,11 @@
 # Ease import statements
 # ------------------------------------------------------------------------------
 
+from .constants import DEFAULT_BRANCH_NAME, DEFAULT_PULL_REQUEST_TITLE
 from .repo_sync import synchronize
+
+__all__ = [
+    "synchronize",
+    "DEFAULT_BRANCH_NAME",
+    "DEFAULT_PULL_REQUEST_TITLE",
+]

src/ansys/tools/repo_sync/__main__.py

@@ -27,16 +27,17 @@
 .. code::
 
     repo-sync \
-      --token <token> \
-      --owner <organization-name> \
-      --repository <repository-name> \
-      --from-dir <path-to-dir-containing-files-to-sync> \
-      --to-dir <target-dir-for-sync> \
-      --include-manifest <path-to-manifest>
+--token <token> \
+--owner <organization-name> \
+--repository <repository-name> \
+--from-dir <path-to-dir-containing-files-to-sync> \
+--to-dir <target-dir-for-sync> \
+--include-manifest <path-to-manifest>
 
 """
 import click
 
+from .constants import DEFAULT_BRANCH_NAME, DEFAULT_PULL_REQUEST_TITLE
 from .repo_sync import synchronize as _synchronize
 
 
@@ -102,14 +103,14 @@
 @click.option(
     "--target-branch-name",
     type=str,
-    default="sync/file-sync",
-    help="Name of the branch to create for the synchronization, by default it is 'sync/file-sync'.",
+    default=DEFAULT_BRANCH_NAME,
+    help=f"Name of the branch to create for the synchronization, by default it is '{DEFAULT_BRANCH_NAME}'.",
 )
 @click.option(
     "--pull-request-title",
     type=str,
-    default="sync: file sync performed by ansys-tools-repo-sync",
-    help="Title of the pull request created after synchronization.",
+    default=DEFAULT_PULL_REQUEST_TITLE,
+    help=f"Title of the pull request created after synchronization, by default it is {DEFAULT_PULL_REQUEST_TITLE}",
 )
 def synchronize(
     owner,

src/ansys/tools/repo_sync/constants.py

@@ -0,0 +1,29 @@
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Module containing constants for the repo sync tool."""
+
+DEFAULT_BRANCH_NAME = "sync/file-sync"
+"""Default branch name for the synchronization process."""
+
+DEFAULT_PULL_REQUEST_TITLE = "sync: file sync performed by ansys-tools-repo-sync"
+"""Default title for the pull request created during synchronization."""

src/ansys/tools/repo_sync/repo_sync.py

@@ -20,6 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+"""Module containing the sync tool implementation."""
+
 from fnmatch import filter
 import os
 import re
@@ -30,6 +32,8 @@
 from git import Repo
 from github import Auth, Github, GithubException
 
+from .constants import DEFAULT_BRANCH_NAME, DEFAULT_PULL_REQUEST_TITLE
+
 
 def include_patterns(*patterns):
     """Include listed patterns in ``copytree()``.
@@ -148,8 +152,8 @@ def synchronize(
     dry_run: bool = False,
     skip_ci: bool = False,
     random_branch_name: bool = False,
-    target_branch_name: str = "sync/file-sync",
-    pull_request_title: str = "sync: file sync performed by ansys-tools-repo-sync",
+    target_branch_name: str = DEFAULT_BRANCH_NAME,
+    pull_request_title: str = DEFAULT_PULL_REQUEST_TITLE,
 ) -> Union[str, None]:
     """Synchronize a folder to a remote repository.
 
@@ -254,7 +258,9 @@ def synchronize(
         repo.index.commit(f"{'[skip ci] ' if skip_ci else ''}sync: add changes from local folder")
 
         # Get a list of the files modified
-        output = repo.git.diff("--compact-summary", f"{branch_checked_out}", f"{target_branch_name}")
+        output = repo.git.diff(
+            "--compact-summary", f"{branch_checked_out}", f"{target_branch_name}"
+        )
 
         # If output is empty, avoid creating PR
         if not output: