feature: add --author parameter (#369)

* feat: add --author parameter to PR body

* refactor: move author to agent init

* build: bump project version

Author: DRMPN

osa_tool/config/settings/arguments.yaml

@@ -129,6 +129,12 @@ settings:
         advanced        — run all enabled features based on provided flags.
     choices: [ "basic", "auto", "advanced" ]
 
+  author:
+    aliases: [ "--author" ]
+    type: str
+    description: |
+      Primarily used for web interface. When set, the tool will add Author to the Pull Request body.
+
   web_mode:
     aliases: [ "--web-mode" ]
     type: flag

osa_tool/git_agent/git_agent.py

@@ -9,10 +9,10 @@
 from git import GitCommandError, InvalidGitRepositoryError, Repo
 
 from osa_tool.analytics.metadata import (
-    RepositoryMetadata,
     GitHubMetadataLoader,
     GitLabMetadataLoader,
     GitverseMetadataLoader,
+    RepositoryMetadata,
 )
 from osa_tool.utils.logger import logger
 from osa_tool.utils.utils import get_base_repo_url, parse_folder_name
@@ -25,7 +25,8 @@ class GitAgent(abc.ABC):
     commit and push changes, and create pull requests.
 
     Attributes:
-        AGENT_SIGNATURE: A signature string appended to pull request descriptions.
+        agent_signature: A signature string appended to a pull request descriptions.
+        author: An author name that appended to a pull request description.
         repo_url: The URL of the Git repository.
         clone_dir: The directory where the repository will be cloned.
         branch_name: The name of the branch to be created.
@@ -37,20 +38,17 @@ class GitAgent(abc.ABC):
         pr_report_body: A formatted message for a pull request.
     """
 
-    AGENT_SIGNATURE = (
-        "\n\n---\n*This PR was created by [osa_tool](https://github.com/aimclub/OSA).*"
-        "\n_OSA just makes your open source project better!_"
-    )
-
-    def __init__(self, repo_url: str, repo_branch_name: str = None, branch_name: str = "osa_tool"):
+    def __init__(self, repo_url: str, repo_branch_name: str = None, branch_name: str = "osa_tool", author: str = None):
         """Initializes the agent with repository info.
 
         Args:
             repo_url: The URL of the GitHub repository.
             repo_branch_name: The name of the repository's branch to be checked out.
             branch_name: The name of the branch to be created. Defaults to "osa_tool".
+            author: The name of the author of the pull request.
         """
         load_dotenv()
+        self.author = author
         self.repo_url = repo_url
         self.clone_dir = os.path.join(os.getcwd(), parse_folder_name(repo_url))
         self.branch_name = branch_name
@@ -61,6 +59,17 @@ def __init__(self, repo_url: str, repo_branch_name: str = None, branch_name: str
         self.base_branch = repo_branch_name or self.metadata.default_branch
         self.pr_report_body = ""
 
+    @property
+    def agent_signature(self) -> str:
+        signature = "\n\n---"
+        if self.author:
+            signature += f"\n*Author: {self.author}.*"
+        signature += (
+            "\n*This PR was created by [osa_tool](https://github.com/aimclub/OSA).*"
+            "\n_OSA just makes your open source project better!_"
+        )
+        return signature
+
     @abc.abstractmethod
     def _get_token(self) -> str:
         """Return platform-specific token from environment."""
@@ -438,7 +447,7 @@ def create_pull_request(self, title: str = None, body: str = None) -> None:
         pr_title = title if title else last_commit.message
         pr_body = body if body else last_commit.message
         pr_body += self.pr_report_body
-        pr_body += self.AGENT_SIGNATURE
+        pr_body += self.agent_signature
         pr_data = {
             "title": pr_title,
             "head": head_branch,
@@ -648,7 +657,7 @@ def create_pull_request(self, title: str = None, body: str = None) -> None:
         mr_title = title if title else last_commit.message
         mr_body = body if body else last_commit.message
         mr_body += self.pr_report_body
-        mr_body += self.AGENT_SIGNATURE
+        mr_body += self.agent_signature
 
         mr_data = {
             "title": mr_title,
@@ -838,7 +847,7 @@ def create_pull_request(self, title: str = None, body: str = None) -> None:
         pr_title = title if title else last_commit.message
         pr_body = body if body else last_commit.message
         pr_body += self.pr_report_body
-        pr_body += self.AGENT_SIGNATURE
+        pr_body += self.agent_signature
 
         pr_data = {
             "title": pr_title,

osa_tool/run.py

@@ -10,7 +10,10 @@
 from pydantic import ValidationError
 
 from osa_tool.aboutgen.about_generator import AboutGenerator
-from osa_tool.analytics.report_maker import ReportGenerator, WhatHasBeenDoneReportGenerator
+from osa_tool.analytics.report_maker import (
+    ReportGenerator,
+    WhatHasBeenDoneReportGenerator,
+)
 from osa_tool.analytics.sourcerank import SourceRank
 from osa_tool.config.settings import ConfigLoader, GitSettings
 from osa_tool.conversion.notebook_converter import NotebookConverter
@@ -249,13 +252,13 @@ def main():
 
 def initialize_git_platform(args):
     if "github.com" in args.repository:
-        git_agent = GitHubAgent(args.repository, args.branch)
+        git_agent = GitHubAgent(args.repository, args.branch, author=args.author)
         workflow_manager = GitHubWorkflowManager(args.repository, git_agent.metadata, args)
     elif "gitlab." in args.repository:
-        git_agent = GitLabAgent(args.repository, args.branch)
+        git_agent = GitLabAgent(args.repository, args.branch, author=args.author)
         workflow_manager = GitLabWorkflowManager(args.repository, git_agent.metadata, args)
     elif "gitverse.ru" in args.repository:
-        git_agent = GitverseAgent(args.repository, args.branch)
+        git_agent = GitverseAgent(args.repository, args.branch, author=args.author)
         workflow_manager = GitverseWorkflowManager(args.repository, git_agent.metadata, args)
     else:
         raise ValueError(f"Cannot initialize Git Agent and Workflow Manager for this platform: {args.repository}")

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "osa_tool"
-version = "0.2.5.1"
+version = "0.2.6"
 description = "Tool that just makes your open source project better!"
 requires-python = ">=3.10,<4.0"
 authors = [