osa_tool 0.2.1__tar.gz → 0.2.2__tar.gz

{osa_tool-0.2.1 → osa_tool-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osa_tool
-Version: 0.2.1
+Version: 0.2.2
 Summary: Tool that just makes your open source project better!
 License: BSD-3-Clause
 Author: ITMO-NSS-team
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: ProtoLLM (>=0.1.2)
+Requires-Dist: ProtoLLM (>=0.1.5)
 Requires-Dist: PyYAML (==6.0.2)
 Requires-Dist: Pygments (==2.19.1)
 Requires-Dist: aiofiles (>=24.1.0,<25.0.0)
@@ -60,6 +60,7 @@ Requires-Dist: pydantic (>=2.9.0,<2.11.0)
 Requires-Dist: pydantic-extra-types (==2.9.0)
 Requires-Dist: pydantic_core (>=2.23.4,<2.24.0)
 Requires-Dist: pytest (==8.3.4)
+Requires-Dist: pytest-asyncio (==1.1.0)
 Requires-Dist: pytest-mock (==3.14.0)
 Requires-Dist: python-dotenv (==1.0.1)
 Requires-Dist: qrcode (==8.0)
@@ -121,13 +122,15 @@ It also generates advices and recommendations for the repository.
 
 OSA is currently under development, so not all features are implemented.
 
+
+
 ---
 
 ## How it works?
 
-Here is a short demo:
+Here is a short video:
 
-![Animation](./docs/images/osa_demo.gif)
+[![Watch the video](./docs/images/osa_preview.png)](https://www.youtube.com/watch?v=LDSb7JJgKoY)
 
 ---
 
@@ -220,23 +223,29 @@ docker build --build-arg GIT_USER_NAME="your-user-name" --build-arg GIT_USER_EMA
 
 OSA requires Python 3.10 or higher.
 
-File `.env` is required to specify GitHub/GitLab/Gitverse token (GIT_TOKEN) and LLM API key (OPENAI_API_KEY or VSE_GPT_KEY)
+File `.env` is required to specify GitHub/GitLab/Gitverse token (GIT_TOKEN) and LLM API key (OPENAI_API_KEY or
+AUTHORIZATION_KEY)
 
 When running `osa-tool` from CLI, you need to set the GIT_TOKEN and API key first:
 
-```commandline
+```sh
+# Linux / macOS (bash/zsh)
 export OPENAI_API_KEY=<your_api_key>
 export GIT_TOKEN=<your_git_token>
+
+# Windows (PowerShell)
+setx OPENAI_API_KEY "<your_api_key>"
+setx GIT_TOKEN "<your_git_token>"
 ```
 
 ### Tokens
 
-| Token name       | Description                                                                                                        | Mandatory |
-|------------------|--------------------------------------------------------------------------------------------------------------------|-----------|
-| `GIT_TOKEN`      | Personal GitHub/GitLab/Gitverse token used to clone private repositories, access metadata, and interact with its API.       | Yes       |
-| `OPENAI_API_KEY` | API key for accessing [OpenAI](https://platform.openai.com/docs/api-reference/introduction)'s language models.     | No        |
-| `VSE_GPT_KEY`    | API key for [vsegpt](https://vsegpt.ru/Docs/API) LLM provider compatible with OpenAI's API format.                 | No        |
-| `X-API-Key`      | API key for the [pepy.tech](https://pepy.tech/pepy-api) REST API, used to fetch Python package download statistics | No        |
+| Token name          | Description                                                                                                                                                                          | Mandatory |
+|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `GIT_TOKEN`         | Personal GitHub/GitLab/Gitverse token used to clone private repositories, access metadata, and interact with its API.                                                                | Yes       |
+| `OPENAI_API_KEY`    | API key for accessing [OpenAI](https://platform.openai.com/docs/api-reference/introduction), [vsegpt](https://vsegpt.ru/Docs/API) and [openrouter](https://openrouter.ai/) providers | No        |
+| `AUTHORIZATION_KEY` | API key for [gigachat](https://developers.sber.ru/portal/products/gigachat-api) provider                                                                                             | No        |
+| `X-API-Key`         | API key for the [pepy.tech](https://pepy.tech/pepy-api) REST API, used to fetch Python package download statistics                                                                   | No        |
 
 ### Usage
 
@@ -274,15 +283,14 @@ documentation, see the [GitHub Action Workflow Generator README](./osa_tool/gith
 | `--api`              | LLM API service provider                                                            | `itmo`                      |
 | `--base-url`         | URL of the provider compatible with API OpenAI                                      | `https://api.openai.com/v1` |
 | `--model`            | Specific LLM model to use                                                           | `gpt-3.5-turbo`             |
+| `--top_p`            | Nucleus sampling probability                                                        | `None`                      |
+| `--temperature`      | Sampling temperature to use for the LLM output (0 = deterministic, 1 = creative).   | `None`                      |
+| `--max_tokens`       | Maximum number of tokens the model can generate in a single response                | `None`                      |
 | `--article`          | Link to the pdf file of the article                                                 | `None`                      |
-| `--translate-dirs`   | Enable automatic translation of the directory name into English                     | `disabled`                  |
 | `-m`, `--mode`       | Operation mode for repository processing: `basic`, `auto` (default), or `advanced`. | `auto`                      |
 | `--delete-dir`       | Enable deleting the downloaded repository after processing                          | `disabled`                  |
 | `--no-fork`          | Avoid create fork for target repository                                             | `False`                     |
 | `--no-pull-request`  | Avoid create pull request for target repository                                     | `False`                     |
-| `--top_p`            | Nucleus sampling probability                                                        | `null`                      |
-| `--temperature`      | Sampling temperature to use for the LLM output (0 = deterministic, 1 = creative).   | `null`                      |
-| `--max_tokens`       | Maximum number of tokens the model can generate in a single response                | `null`                      |
 
 To learn how to work with the interactive CLI and view descriptions of all available keys, visit
 the [CLI usage guide](./osa_tool/scheduler/README.md).
@@ -293,19 +301,17 @@ the [CLI usage guide](./osa_tool/scheduler/README.md).
 
 Examples of generated README files are available in [examples](https://github.com/aimclub/OSA/tree/main/examples).
 
-URL of the GitHub/GitLab/Gitverse repository, LLM API service provider (*optional*) and Specific LLM model to use (*optional*) are
-required to use the generator.
+URL of the GitHub/GitLab/Gitverse repository, LLM API service provider (*optional*) and Specific LLM model to use
+(*optional*) are required to use the generator.
 
-To see available models go there:
-
-1. [VseGpt](https://vsegpt.ru/Docs/Models)
-2. [OpenAI](https://platform.openai.com/docs/models)
-3. [Ollama](https://ollama.com/library)
+Supported LLM providers are available as part of the [ProtoLLM](https://github.com/aimclub/ProtoLLM/)
+ecosystem. See the [connectors directory](https://github.com/aimclub/ProtoLLM/tree/main/protollm/connectors) for the
+full list.
 
 Local ITMO model:
 
 ```sh
-python -m osa_tool.run -r https://github.com/aimclub/OSA --base_url [ITMO_MODEL_URL]
+python -m osa_tool.run -r https://github.com/aimclub/OSA --base-url [ITMO_MODEL_URL]
 ```  
 
 For this API provider itmo model url must be specified in dotenv (ITMO_MODEL_URL=) or in the --base-url argument.
@@ -322,6 +328,12 @@ VseGPT:
 python -m osa_tool.run -r https://github.com/aimclub/OSA --api openai --base-url https://api.vsegpt.ru/v1 --model openai/gpt-3.5-turbo
 ```
 
+Openrouter:
+
+```sh
+python -m osa_tool.run -r https://github.com/aimclub/OSA --api openai --base-url https://openrouter.ai/api/v1 --model qwen/qwen3-30b-a3b-instruct-2507
+```
+
 Ollama:
 
 ```sh
@@ -338,7 +350,8 @@ Detailed description of OSA API is available [here](https://aimclub.github.io/OS
 
 ## Chat with developers: OSA_helpdesk
 
-In our Telegram chat [OSA_helpdesk](t.me/osa_helpdesk) you can ask questions about working with OSA and find the latest news about the project.
+In our Telegram chat [OSA_helpdesk](t.me/osa_helpdesk) you can ask questions about working with OSA and find the latest
+news about the project.
 
 ---
 
@@ -385,29 +398,20 @@ for their code that we used as a foundation for our own version of README genera
 
 If you use this software, please cite it as below.
 
-### APA format
+### Simple format
 
-    ITMO, NSS Lab (2025). Open-Source-Advisor repository [Computer software]. https://github.com/aimclub/OSA
+    Nikitin N. et al. An LLM-Powered Tool for Enhancing Scientific Open-Source Repositories // Championing Open-source DEvelopment in ML Workshop@ ICML25.
 
 ### BibTeX format
 
-    @misc{Open-Source-Advisor,
-
-        author = {ITMO, NSS Lab},
-
-        title = {Open-Source-Advisor repository},
-
-        year = {2025},
-
-        publisher = {github.com},
-
-        journal = {github.com repository},
-
-        howpublished = {\url{https://github.com/aimclub/OSA.git}},
-
-        url = {https://github.com/aimclub/OSA.git}
+    @inproceedings{nikitinllm,
+    title={An LLM-Powered Tool for Enhancing Scientific Open-Source Repositories},
+    author={Nikitin, Nikolay and Getmanov, Andrey and Popov, Zakhar and 
+        Ulyanova Ekaterina and Aksenkin, Yaroslav and 
+        Sokolov, Ilya and Boukhanovsky, Alexander},
+    booktitle={Championing Open-source DEvelopment in ML Workshop@ ICML25}
 
-    }
+}
 
 ---
 

{osa_tool-0.2.1 → osa_tool-0.2.2}/README.md

@@ -36,13 +36,15 @@ It also generates advices and recommendations for the repository.
 
 OSA is currently under development, so not all features are implemented.
 
+
+
 ---
 
 ## How it works?
 
-Here is a short demo:
+Here is a short video:
 
-![Animation](./docs/images/osa_demo.gif)
+[![Watch the video](./docs/images/osa_preview.png)](https://www.youtube.com/watch?v=LDSb7JJgKoY)
 
 ---
 
@@ -135,23 +137,29 @@ docker build --build-arg GIT_USER_NAME="your-user-name" --build-arg GIT_USER_EMA
 
 OSA requires Python 3.10 or higher.
 
-File `.env` is required to specify GitHub/GitLab/Gitverse token (GIT_TOKEN) and LLM API key (OPENAI_API_KEY or VSE_GPT_KEY)
+File `.env` is required to specify GitHub/GitLab/Gitverse token (GIT_TOKEN) and LLM API key (OPENAI_API_KEY or
+AUTHORIZATION_KEY)
 
 When running `osa-tool` from CLI, you need to set the GIT_TOKEN and API key first:
 
-```commandline
+```sh
+# Linux / macOS (bash/zsh)
 export OPENAI_API_KEY=<your_api_key>
 export GIT_TOKEN=<your_git_token>
+
+# Windows (PowerShell)
+setx OPENAI_API_KEY "<your_api_key>"
+setx GIT_TOKEN "<your_git_token>"
 ```
 
 ### Tokens
 
-| Token name       | Description                                                                                                        | Mandatory |
-|------------------|--------------------------------------------------------------------------------------------------------------------|-----------|
-| `GIT_TOKEN`      | Personal GitHub/GitLab/Gitverse token used to clone private repositories, access metadata, and interact with its API.       | Yes       |
-| `OPENAI_API_KEY` | API key for accessing [OpenAI](https://platform.openai.com/docs/api-reference/introduction)'s language models.     | No        |
-| `VSE_GPT_KEY`    | API key for [vsegpt](https://vsegpt.ru/Docs/API) LLM provider compatible with OpenAI's API format.                 | No        |
-| `X-API-Key`      | API key for the [pepy.tech](https://pepy.tech/pepy-api) REST API, used to fetch Python package download statistics | No        |
+| Token name          | Description                                                                                                                                                                          | Mandatory |
+|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `GIT_TOKEN`         | Personal GitHub/GitLab/Gitverse token used to clone private repositories, access metadata, and interact with its API.                                                                | Yes       |
+| `OPENAI_API_KEY`    | API key for accessing [OpenAI](https://platform.openai.com/docs/api-reference/introduction), [vsegpt](https://vsegpt.ru/Docs/API) and [openrouter](https://openrouter.ai/) providers | No        |
+| `AUTHORIZATION_KEY` | API key for [gigachat](https://developers.sber.ru/portal/products/gigachat-api) provider                                                                                             | No        |
+| `X-API-Key`         | API key for the [pepy.tech](https://pepy.tech/pepy-api) REST API, used to fetch Python package download statistics                                                                   | No        |
 
 ### Usage
 
@@ -189,15 +197,14 @@ documentation, see the [GitHub Action Workflow Generator README](./osa_tool/gith
 | `--api`              | LLM API service provider                                                            | `itmo`                      |
 | `--base-url`         | URL of the provider compatible with API OpenAI                                      | `https://api.openai.com/v1` |
 | `--model`            | Specific LLM model to use                                                           | `gpt-3.5-turbo`             |
+| `--top_p`            | Nucleus sampling probability                                                        | `None`                      |
+| `--temperature`      | Sampling temperature to use for the LLM output (0 = deterministic, 1 = creative).   | `None`                      |
+| `--max_tokens`       | Maximum number of tokens the model can generate in a single response                | `None`                      |
 | `--article`          | Link to the pdf file of the article                                                 | `None`                      |
-| `--translate-dirs`   | Enable automatic translation of the directory name into English                     | `disabled`                  |
 | `-m`, `--mode`       | Operation mode for repository processing: `basic`, `auto` (default), or `advanced`. | `auto`                      |
 | `--delete-dir`       | Enable deleting the downloaded repository after processing                          | `disabled`                  |
 | `--no-fork`          | Avoid create fork for target repository                                             | `False`                     |
 | `--no-pull-request`  | Avoid create pull request for target repository                                     | `False`                     |
-| `--top_p`            | Nucleus sampling probability                                                        | `null`                      |
-| `--temperature`      | Sampling temperature to use for the LLM output (0 = deterministic, 1 = creative).   | `null`                      |
-| `--max_tokens`       | Maximum number of tokens the model can generate in a single response                | `null`                      |
 
 To learn how to work with the interactive CLI and view descriptions of all available keys, visit
 the [CLI usage guide](./osa_tool/scheduler/README.md).
@@ -208,19 +215,17 @@ the [CLI usage guide](./osa_tool/scheduler/README.md).
 
 Examples of generated README files are available in [examples](https://github.com/aimclub/OSA/tree/main/examples).
 
-URL of the GitHub/GitLab/Gitverse repository, LLM API service provider (*optional*) and Specific LLM model to use (*optional*) are
-required to use the generator.
+URL of the GitHub/GitLab/Gitverse repository, LLM API service provider (*optional*) and Specific LLM model to use
+(*optional*) are required to use the generator.
 
-To see available models go there:
-
-1. [VseGpt](https://vsegpt.ru/Docs/Models)
-2. [OpenAI](https://platform.openai.com/docs/models)
-3. [Ollama](https://ollama.com/library)
+Supported LLM providers are available as part of the [ProtoLLM](https://github.com/aimclub/ProtoLLM/)
+ecosystem. See the [connectors directory](https://github.com/aimclub/ProtoLLM/tree/main/protollm/connectors) for the
+full list.
 
 Local ITMO model:
 
 ```sh
-python -m osa_tool.run -r https://github.com/aimclub/OSA --base_url [ITMO_MODEL_URL]
+python -m osa_tool.run -r https://github.com/aimclub/OSA --base-url [ITMO_MODEL_URL]
 ```  
 
 For this API provider itmo model url must be specified in dotenv (ITMO_MODEL_URL=) or in the --base-url argument.
@@ -237,6 +242,12 @@ VseGPT:
 python -m osa_tool.run -r https://github.com/aimclub/OSA --api openai --base-url https://api.vsegpt.ru/v1 --model openai/gpt-3.5-turbo
 ```
 
+Openrouter:
+
+```sh
+python -m osa_tool.run -r https://github.com/aimclub/OSA --api openai --base-url https://openrouter.ai/api/v1 --model qwen/qwen3-30b-a3b-instruct-2507
+```
+
 Ollama:
 
 ```sh
@@ -253,7 +264,8 @@ Detailed description of OSA API is available [here](https://aimclub.github.io/OS
 
 ## Chat with developers: OSA_helpdesk
 
-In our Telegram chat [OSA_helpdesk](t.me/osa_helpdesk) you can ask questions about working with OSA and find the latest news about the project.
+In our Telegram chat [OSA_helpdesk](t.me/osa_helpdesk) you can ask questions about working with OSA and find the latest
+news about the project.
 
 ---
 
@@ -300,28 +312,19 @@ for their code that we used as a foundation for our own version of README genera
 
 If you use this software, please cite it as below.
 
-### APA format
+### Simple format
 
-    ITMO, NSS Lab (2025). Open-Source-Advisor repository [Computer software]. https://github.com/aimclub/OSA
+    Nikitin N. et al. An LLM-Powered Tool for Enhancing Scientific Open-Source Repositories // Championing Open-source DEvelopment in ML Workshop@ ICML25.
 
 ### BibTeX format
 
-    @misc{Open-Source-Advisor,
-
-        author = {ITMO, NSS Lab},
-
-        title = {Open-Source-Advisor repository},
-
-        year = {2025},
-
-        publisher = {github.com},
-
-        journal = {github.com repository},
-
-        howpublished = {\url{https://github.com/aimclub/OSA.git}},
-
-        url = {https://github.com/aimclub/OSA.git}
+    @inproceedings{nikitinllm,
+    title={An LLM-Powered Tool for Enhancing Scientific Open-Source Repositories},
+    author={Nikitin, Nikolay and Getmanov, Andrey and Popov, Zakhar and 
+        Ulyanova Ekaterina and Aksenkin, Yaroslav and 
+        Sokolov, Ilya and Boukhanovsky, Alexander},
+    booktitle={Championing Open-source DEvelopment in ML Workshop@ ICML25}
 
-    }
+}
 
 ---

{osa_tool-0.2.1 → osa_tool-0.2.2}/osa_tool/aboutgen/about_generator.py

@@ -137,7 +137,7 @@ class AboutGenerator:
             topics = [topic.strip().lower().replace(" ", "-") for topic in response.split(",") if topic.strip()]
             logger.debug(f"Generated topics from LLM: {topics}")
             validated_topics = self._validate_topics(topics)
-            return list(set([*existing_topics, *validated_topics]))
+            return list({*existing_topics, *validated_topics})
         except Exception as e:
             logger.error(f"Error generating topics: {e}")
             return []
@@ -161,7 +161,8 @@ class AboutGenerator:
             logger.warning(f"Topic validation not implemented for platform: {self.platform}")
             return topics
 
-    def _validate_github_topics(self, topics: List[str]) -> List[str]:
+    @staticmethod
+    def _validate_github_topics(topics: List[str]) -> List[str]:
         """Validates topics against GitHub Topics API.
 
         Args:
@@ -205,7 +206,8 @@ class AboutGenerator:
         logger.info(f"Validated {len(validated_topics)} topics out of {len(topics)}.")
         return validated_topics
 
-    def _validate_gitlab_topics(self, topics: List[str]) -> List[str]:
+    @staticmethod
+    def _validate_gitlab_topics(topics: List[str]) -> List[str]:
         """Validates topics against GitLab Topics API.
 
         Args:
@@ -243,7 +245,8 @@ class AboutGenerator:
         logger.info(f"Validated {len(validated_topics)} topics out of {len(topics)}.")
         return validated_topics
 
-    def _validate_gitverse_topics(self, topics: List[str]) -> List[str]:
+    @staticmethod
+    def _validate_gitverse_topics(topics: List[str]) -> List[str]:
         """Validates topics for Gitverse platform.
 
         Args:
@@ -285,7 +288,8 @@ class AboutGenerator:
 
         return candidates[0] if candidates else ""
 
-    def _extract_readme_urls(self, readme_content: str) -> List[str]:
+    @staticmethod
+    def _extract_readme_urls(readme_content: str) -> List[str]:
         """Extract all absolute URLs from README content"""
         logger.info("Extracting URLs from README.")
         url_pattern = r"(?:http|ftp|https):\/\/(?:[\w_-]+(?:(?:\.[\w_-]+)+))(?:[\w.,@?^=%&:\/~+#-]*[\w@?^=%&\/~+#-])"

{osa_tool-0.2.1 → osa_tool-0.2.2}/osa_tool/analytics/metadata.py

@@ -171,6 +171,7 @@ def _parse_repository_metadata_gitlab(repo_data: dict) -> RepositoryMetadata:
 def _parse_repository_metadata_gitverse(repo_data: dict) -> RepositoryMetadata:
     """Parse Gitverse API response into RepositoryMetadata."""
     owner_info = repo_data.get("owner", {}) or {}
+    license_info = repo_data.get("license") or {}
 
     return RepositoryMetadata(
         name=repo_data.get("name", ""),
@@ -200,8 +201,8 @@ def _parse_repository_metadata_gitverse(repo_data: dict) -> RepositoryMetadata:
         has_projects=repo_data.get("has_projects", False),
         is_private=repo_data.get("private", False),
         homepage_url=repo_data.get("homepage", ""),
-        license_name=repo_data.get("license", {}).get("name", ""),
-        license_url=repo_data.get("license", {}).get("url", ""),
+        license_name=license_info.get("name", ""),
+        license_url=license_info.get("url", ""),
         platform="gitverse",
     )
 

{osa_tool-0.2.1 → osa_tool-0.2.2}/osa_tool/analytics/prompt_builder.py

@@ -1,7 +1,7 @@
-from pydantic import BaseModel, Field
-from typing import List
 from enum import Enum
 
+from pydantic import BaseModel, Field
+
 
 class YesNoPartial(str, Enum):
     YES = "Yes"
@@ -12,7 +12,7 @@ class YesNoPartial(str, Enum):
 
 class RepositoryStructure(BaseModel):
     compliance: str = Field("Unknown", description="Compliance with standard structure")
-    missing_files: List[str] = Field(
+    missing_files: list[str] = Field(
         default_factory=list,
         description="List of missing critical files that impact project usability and clarity",
     )
@@ -45,11 +45,11 @@ class CodeDocumentation(BaseModel):
 
 
 class OverallAssessment(BaseModel):
-    key_shortcomings: List[str] = Field(
+    key_shortcomings: list[str] = Field(
         default_factory=lambda: ["There are no critical issues"],
         description="List of the most significant and critical issues that need to be addressed",
     )
-    recommendations: List[str] = Field(
+    recommendations: list[str] = Field(
         default_factory=lambda: ["No recommendations"],
         description="Specific improvements to address issues or optimize the process",
     )

{osa_tool-0.2.1 → osa_tool-0.2.2}/osa_tool/analytics/report_maker.py

@@ -14,6 +14,7 @@ from reportlab.platypus import (
     Spacer,
     Table,
     TableStyle,
+    Flowable,
 )
 
 from osa_tool.analytics.metadata import load_data_metadata
@@ -247,7 +248,7 @@ class ReportGenerator:
         )
         return bullet_list
 
-    def body_second_part(self) -> list:
+    def body_second_part(self) -> list[Flowable]:
         """
         Generates the second part of the report, which contains the analysis of the repository.
 
@@ -353,7 +354,6 @@ class ReportGenerator:
                 pagesize=A4,
                 topMargin=50,
                 bottomMargin=40,
-                leftMaring=10,
             )
             doc.build(
                 [

{osa_tool-0.2.1 → osa_tool-0.2.2}/osa_tool/analytics/run_report_gen.py

@@ -6,7 +6,7 @@ import pandas as pd
 
 from osa_tool.analytics.report_maker import ReportGenerator
 from osa_tool.analytics.sourcerank import SourceRank
-from osa_tool.github_agent.github_agent import GithubAgent
+from osa_tool.git_agent.git_agent import GitAgent
 from osa_tool.readmegen.context.pypi_status_checker import PyPiPackageInspector
 from osa_tool.run import load_configuration
 from osa_tool.utils import logger, rich_section, delete_repository
@@ -78,7 +78,7 @@ def main():
         )
 
         # Clone the repository
-        github_agent = GithubAgent(repo_url)
+        github_agent = GitAgent(repo_url)
         github_agent.clone_repository()
 
         # Initialize analytics and generate report

{osa_tool-0.2.1 → osa_tool-0.2.2}/osa_tool/arguments_parser.py

@@ -1,20 +1,22 @@
 import argparse
+from typing import Any
 
+import tomli
 import yaml
 
+from osa_tool.utils import build_arguments_path, build_config_path
 
-def build_parser_from_yaml(yaml_path: str) -> argparse.ArgumentParser:
+
+def build_parser_from_yaml() -> argparse.ArgumentParser:
     """
     Build an ArgumentParser based on a YAML configuration file.
 
-    Args:
-        yaml_path: Path to the YAML file defining CLI arguments.
-
     Returns:
         argparse.ArgumentParser: Configured argument parser.
     """
 
-    config = read_arguments_file(yaml_path)
+    config_yaml = read_arguments_file(build_arguments_path())
+    config_toml = read_config_file(build_config_path())
 
     parser = argparse.ArgumentParser(
         description="Generated CLI parser from YAML configuration",
@@ -26,39 +28,34 @@ def build_parser_from_yaml(yaml_path: str) -> argparse.ArgumentParser:
             aliases = options.get("aliases", [])
             arg_type = options.get("type", "str")
             description = options.get("description", "")
-            default = options.get("default")
             choices = options.get("choices")
-
+            default = get_default_from_config(config_toml, key)
             kwargs = {"help": description}
 
             if arg_type == "flag":
                 kwargs["action"] = "store_true"
-                if default is not None:
-                    kwargs["default"] = default
+                kwargs["default"] = default
             elif arg_type == "str":
                 kwargs["type"] = str
-                if default is not None:
-                    kwargs["default"] = default
+                kwargs["default"] = default
                 if choices:
                     kwargs["choices"] = choices
             elif arg_type == "int":
                 kwargs["type"] = int
-                if default is not None:
-                    kwargs["default"] = default
+                kwargs["default"] = default
             elif arg_type == "list":
                 kwargs["nargs"] = "+"
                 kwargs["type"] = str
-                if default is not None:
-                    kwargs["default"] = default
+                kwargs["default"] = default
             else:
                 raise ValueError(f"Unsupported type '{arg_type}' for argument '{key}'")
 
             group.add_argument(*aliases, **kwargs)
 
-    core_args = {k: v for k, v in config.items() if not isinstance(v, dict) or "type" in v}
+    core_args = {k: v for k, v in config_yaml.items() if not isinstance(v, dict) or "type" in v}
     add_arguments(parser, core_args)
 
-    for group_name, group_args in config.items():
+    for group_name, group_args in config_yaml.items():
         if isinstance(group_args, dict) and "type" not in group_args:
             arg_group = parser.add_argument_group(f"{group_name} arguments")
             add_arguments(arg_group, group_args)
@@ -66,8 +63,8 @@ def build_parser_from_yaml(yaml_path: str) -> argparse.ArgumentParser:
     return parser
 
 
-def get_keys_from_group_in_yaml(yaml_path, group_name) -> list:
-    data = read_arguments_file(yaml_path)
+def get_keys_from_group_in_yaml(group_name: str) -> list:
+    data = read_arguments_file(build_arguments_path())
     keys = []
     for key, params in data.items():
         if key == group_name:
@@ -75,7 +72,7 @@ def get_keys_from_group_in_yaml(yaml_path, group_name) -> list:
     return keys
 
 
-def read_arguments_file_flat(yaml_path) -> dict:
+def read_arguments_file_flat(yaml_path: str) -> dict:
     """
     Read YAML arguments file and flatten nested groups into a single dict.
     """
@@ -92,7 +89,24 @@ def read_arguments_file_flat(yaml_path) -> dict:
     return flat_data
 
 
-def read_arguments_file(yaml_path) -> dict:
+def get_default_from_config(config: dict, key: str) -> Any:
+    """
+    Find default value for a key in config dict by searching all top-level sections.
+    """
+    for section, values in config.items():
+        if isinstance(values, dict) and key in values:
+            return values[key]
+    return None
+
+
+def read_arguments_file(yaml_path: str) -> dict:
     with open(yaml_path, "r", encoding="utf-8") as f:
         data = yaml.safe_load(f)
     return data
+
+
+def read_config_file(toml_path: str) -> dict[str, Any]:
+    """Load TOML config as a nested dict."""
+    with open(toml_path, "rb") as f:
+        data = tomli.load(f)
+    return {k.lower(): v for k, v in data.items()}