osa_tool 0.3.3__tar.gz → 0.3.4__tar.gz

{osa_tool-0.3.3 → osa_tool-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osa_tool
-Version: 0.3.3
+Version: 0.3.4
 Summary: Tool that just makes your open source project better!
 License-Expression: BSD-3-Clause
 License-File: LICENSE

{osa_tool-0.3.3 → osa_tool-0.3.4}/osa_tool/config/settings.py

@@ -64,6 +64,10 @@ class GitSettings(BaseModel):
             else:
                 raise ValueError(f"{self.repository} does not exist.")
         else:
+            # A URL copied from a browser often carries a trailing slash, and the
+            # remote helpers append ".git" to this value verbatim, which would make
+            # "owner/repo/" into "owner/repo/.git" and fail the clone.
+            self.repository = str(self.repository).rstrip("/")
             self.host_domain, self.host, self.name, self.full_name = parse_git_url(str(self.repository))
         return self
 

{osa_tool-0.3.3 → osa_tool-0.3.4}/osa_tool/operations/codebase/docstring_generation/docgen.py

@@ -1522,6 +1522,30 @@ class DocGen(object):
         dot_path = ".".join(processed_parts)
         return f"::: {dot_path}"
 
+    @staticmethod
+    def _path_inside_repo(target: str | Path, repo_path: Path) -> Path:
+        """
+        Returns a path relative to the repository root.
+
+        Analysis results carry absolute paths whenever OSA runs with --output.
+        Dropping only the leading component then leaves the rest of the filesystem
+        prefix in place, which nests osa_docs under the machine's own directory
+        tree and, on Windows, pushes the result past the path length limit.
+
+        Args:
+            target: The analysed file or directory path.
+            repo_path: The resolved root of the analysed repository.
+
+        Returns:
+            Path: The target expressed relative to the repository root.
+        """
+        candidate = Path(target)
+        try:
+            return candidate.resolve().relative_to(repo_path)
+        except ValueError:
+            # callers may pass a path that merely starts with the repository directory
+            return Path(*candidate.parts[1:])
+
     def generate_documentation_mkdocs(self, path: str, files_info, modules_info) -> None:
         """
         Generates MkDocs documentation for a Python project based on provided path.
@@ -1547,8 +1571,8 @@ class DocGen(object):
                 continue
             parent_dir = Path(file).parent
             file_name = Path(file).name
-            relative_path = Path(*Path(file).parts[1::])
-            new_path = Path(init_doc_path, Path(*Path(parent_dir).parts[1::]))
+            relative_path = self._path_inside_repo(file, repo_path)
+            new_path = Path(init_doc_path, self._path_inside_repo(parent_dir, repo_path))
             new_path.mkdir(parents=True, exist_ok=True)
             text = (
                 f"# {file_name.strip('.py').replace('_', ' ').title()}\n\n"
@@ -1559,7 +1583,7 @@ class DocGen(object):
             new_file.write_text(text)
 
         for module in modules_info:
-            new_file = Path(init_doc_path, Path(*Path(module).parts[1::]))
+            new_file = Path(init_doc_path, self._path_inside_repo(module, repo_path))
             new_file.mkdir(parents=True, exist_ok=True)
             text = modules_info[module]
             Path(new_file, "index.md").write_text(text)

{osa_tool-0.3.3 → osa_tool-0.3.4}/osa_tool/operations/docs/readme_generation/sections/header.py

@@ -15,6 +15,10 @@ from osa_tool.tools.repository_analysis.sourcerank import SourceRank
 from osa_tool.utils.logger import logger
 from osa_tool.utils.utils import osa_project_root, resolve_repo_path, resolve_repo_web_identity
 
+# Shields.io badge style applied to the tech icons. Every URL in shieldsio_icons.json
+# carries a single "{0}" placeholder for it; "flat" matches the license badge above them.
+BADGE_STYLE = "flat"
+
 
 class HeaderBuilder:
     """Produce the top-of-README header with project name, info badges, and tech badges."""
@@ -129,7 +133,7 @@ class HeaderBuilder:
         badges: list[str] = ["Built with:\n"]
         for tech in sorted(self.techs):
             if tech in icons:
-                badges.append(f"![{tech}]({icons[tech][0]})")
+                badges.append(f"![{tech}]({icons[tech][0].format(BADGE_STYLE)})")
             if len(badges) >= self.max_tech_badges + 1:
                 break
         if len(badges) <= 3:

{osa_tool-0.3.3 → osa_tool-0.3.4}/pyproject.toml

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