fix: Handle local repo parsing error when path < 2 indexes.

eli64s · Oct 22, 2023 · d558959 · d558959
1 parent 179dc2c
commit d558959
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 1,966 deletions.
diff --git a/.gitignore b/.gitignore
@@ -45,7 +45,7 @@ notebooks/
 .benchmarks/
 
 # Other
-docs/templates
+docs/docs
 docs/notes
 examples/readme-edgecase.md
 readmeai/conf/templates

diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 <div align="right">
 
-[![CN](https://img.shields.io/badge/CN-🇨🇳-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-zh-CN.md)  
-[![DE](https://img.shields.io/badge/DE-🇩🇪-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-de.md)  
-[![FR](https://img.shields.io/badge/FR-🇫🇷-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-fr.md)  
+[![CN](https://img.shields.io/badge/CN-🇨🇳-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-zh-CN.md)
+[![DE](https://img.shields.io/badge/DE-🇩🇪-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-de.md)
+[![FR](https://img.shields.io/badge/FR-🇫🇷-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-fr.md)
 </div>
 
 <div align="center">

diff --git a/docs/README-de.md b/docs/README-de.md
diff --git a/docs/README-fr.md b/docs/README-fr.md
diff --git a/docs/README-zh-CN.md b/docs/README-zh-CN.md
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,4 @@
+# README-AI
+
+
+## Why README-AI?
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "readmeai"
-version = "0.4.030"
+version = "0.4.031"
 description = "Automated README.md file generator tool, powered by AI 🧚"
 authors = ["Eli <[email protected]>"]
 license = "MIT"

diff --git a/readmeai/services/version_control.py b/readmeai/services/version_control.py
@@ -124,6 +124,9 @@ def validate_file_permissions(temp_dir: Path) -> None:
 
 def get_github_file_link(file: str, repo: str, user_repo_name: str) -> str:
     """Returns the file URL for a given file based on the platform."""
+    if Path(repo).exists():
+        return "local directory"
+
     domain = repo.split("/")[2]
     base_urls = {
         "github.com": f"https://github.com/{user_repo_name}/blob/main/{file}",

diff --git a/readmeai/settings/config.toml b/readmeai/settings/config.toml
@@ -40,7 +40,7 @@ output = "readme-ai.md"
 [prompts]
 code_summary = """Offer a comprehensive summary that encapsulates the core functionalities of the code:
 \nPath: {0}\nContents:\n{1}\n Aim for precision and conciseness in your explanation, ensuring a fine balance between detail and brevity.
-Limit your response to a maximum of 350 characters (including spaces).
+Limit your response to a maximum of 225 characters (including spaces).
 """
 features = """Hello! Analyze the Git codebase {} and create a robust summary of the project's features.
 The following information summarizes each file in the repository to help you get started: \n{}\n