Spaces:

faizee07
/

github-readme-generator

Sleeping

App Files Files Community

faizee07 commited on Oct 15, 2025

Commit

280cc30

verified ·

1 Parent(s): 3db1420

Update app.py

Browse files

Files changed (1) hide show

app.py +91 -94

app.py CHANGED Viewed

@@ -4,17 +4,26 @@ import tempfile
 from flask import Flask, request, jsonify, render_template_string
 import git
 import json
-app = Flask(__name__)
-# --- HTML Template remains embedded. No changes needed here. ---
 HTML_TEMPLATE = """
 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>GitHub README Generator</title>
     <style>
         @import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700&display=swap');
         body { font-family: 'Inter', sans-serif; background-color: #f0f2f5; color: #1c1e21; margin: 0; display: flex; justify-content: center; align-items: center; min-height: 100vh; padding: 20px; box-sizing: border-box; }
@@ -34,8 +43,8 @@ HTML_TEMPLATE = """
 </head>
 <body>
     <div class="container">
-        <h1>GitHub README Generator 💻</h1>
-        <p>Enter a public GitHub repository URL and let the AI agent generate a professional README.md for you.</p>
         <form id="repo-form"><div class="input-group"><input type="url" id="repo-url" placeholder="e.g., https://github.com/user/project" required><button type="submit">Generate</button></div></form>
         <div class="loader" id="loader"></div>
         <div id="result-container"><h2>Generated README.md:</h2><pre id="result"></pre></div>
@@ -67,82 +76,79 @@ HTML_TEMPLATE = """
 </html>
 """
-def analyze_repo(repo_path):
     """
-    Analyzes the cloned repository to gather information.
-    This function now correctly receives the path to the project's root folder.
     """
-    # FIX: The project name is the name of the folder we are analyzing.
-    project_name = os.path.basename(repo_path)
-    language = "Not Detected"
-    dependencies = []
-    install_command = "No specific install command found."
-    run_command = "No specific run command found."
-    purpose = f"A project named '{project_name}'."
-    # --- Smarter Project Purpose Inference ---
-    # Try to find a description from an existing README
-    existing_readme_path = os.path.join(repo_path, 'README.md')
-    if os.path.exists(existing_readme_path):
-        with open(existing_readme_path, 'r', errors='ignore') as f:
-            lines = f.readlines()
-            # Often the first few lines after the title contain a description
-            if len(lines) > 2:
-                purpose = "".join(lines[1:3]).strip() # Grab the first two lines after title
-    # --- Technology and Dependency Analysis ---
-    if os.path.exists(os.path.join(repo_path, 'requirements.txt')):
-        language = "Python"
-        with open(os.path.join(repo_path, 'requirements.txt'), 'r') as f:
-            dependencies = [line.strip() for line in f.readlines() if line.strip() and not line.startswith('#')]
-        install_command = "pip install -r requirements.txt"
-        if 'flask' in str(dependencies).lower():
-            run_command = "flask run"
-        elif 'django' in str(dependencies).lower():
-            run_command = "python manage.py runserver"
-        elif os.path.exists(os.path.join(repo_path, 'app.py')):
-             run_command = "python app.py"
-        elif os.path.exists(os.path.join(repo_path, 'main.py')):
-            run_command = "python main.py"
-    elif os.path.exists(os.path.join(repo_path, 'package.json')):
-        language = "JavaScript (Node.js)"
-        with open(os.path.join(repo_path, 'package.json'), 'r') as f:
-            package_data = json.load(f)
-            dependencies = list(package_data.get('dependencies', {}).keys())
-            if package_data.get('description'):
-                purpose = package_data.get('description')
-        install_command = "npm install"
-        if package_data.get('scripts', {}).get('start'):
-            run_command = "npm start"
-        else:
-            run_command = "node index.js  # (or appropriate main file)"
-    return {
-        "project_name": project_name, "language": language, "dependencies": dependencies,
-        "install_command": install_command, "run_command": run_command, "purpose": purpose
-    }
-def generate_readme_content(analysis):
-    """Generates the README.md content from the analysis results."""
-    readme = f"# {analysis['project_name'].replace('-', ' ').title()}\n\n"
-    readme += f"## 🤖 About This Project\n\n{analysis['purpose']}\n\n"
-    readme += f"This project appears to be written in **{analysis['language']}**.\n\n"
-    readme += "## 🚀 Getting Started\n\n"
-    readme += "### Installation\n\n1.  **Clone the repository:**\n    ```sh\n    git clone <your_repository_url>\n    ```\n\n"
-    readme += f"2. **Navigate into the directory and install dependencies:**\n    ```sh\n    cd {analysis['project_name']}\n    {analysis['install_command']}\n    ```\n\n"
-    if analysis['dependencies']:
-        readme += "### Key Dependencies\n"
-        for dep in analysis['dependencies'][:5]: # Show first 5 dependencies
-            readme += f"- `{dep}`\n"
-        readme += "\n"
-    readme += "### Usage\n\nTo run the application, execute the following command from the project root:\n"
-    readme += f"```sh\n{analysis['run_command']}\n```\n\n"
-    readme += "---\n*This README was automatically generated by an AI agent.*"
-    return readme
 @app.route('/')
 def index():
@@ -151,39 +157,30 @@ def index():
 @app.route('/generate', methods=['POST'])
 def generate():
     repo_url = request.get_json().get('url')
-    if not repo_url or not repo_url.startswith("https://github.com/"):
         return jsonify({"error": "A valid GitHub repository URL is required."}), 400
     temp_dir = tempfile.mkdtemp()
     try:
-        # --- Agent Tool 1: Git Clone ---
-        print(f"Cloning repository: {repo_url}")
         git.Repo.clone_from(repo_url, temp_dir)
-        # --- FIX: Find the actual project folder inside the temp directory ---
-        cloned_folders = os.listdir(temp_dir)
         if not cloned_folders:
             raise Exception("Cloning seems to have failed, the directory is empty.")
-        # The actual repo path is inside the temp_dir
         repo_root_path = os.path.join(temp_dir, cloned_folders[0])
-        print(f"Analysis target found at: {repo_root_path}")
-        # --- Agent Tool 2: File Analysis (now on the correct path) ---
-        analysis_result = analyze_repo(repo_root_path)
-        # --- Agent Step 3: Write README ---
-        readme_content = generate_readme_content(analysis_result)
         return jsonify({"readme": readme_content})
-    except git.exc.GitCommandError as e:
-        return jsonify({"error": f"Failed to clone. Is the URL correct and public? Details: {e}"}), 500
     except Exception as e:
-        return jsonify({"error": f"An unexpected error occurred: {str(e)}"}), 500
     finally:
-        # --- Cleanup ---
-        print(f"Cleaning up temporary directory: {temp_dir}")
         shutil.rmtree(temp_dir)
 if __name__ == '__main__':

 from flask import Flask, request, jsonify, render_template_string
 import git
 import json
+import google.generativeai as genai
+# --- IMPORTANT: Configure your API Key ---
+# For local testing, you can set this directly.
+# For Hugging Face Spaces, you will set this in "Secrets".
+# os.environ['GOOGLE_API_KEY'] = "YOUR_API_KEY_HERE"
+try:
+    genai.configure(api_key=os.environ.get("GOOGLE_API_KEY"))
+except AttributeError:
+    print("WARNING: GOOGLE_API_KEY secret not set. LLM functionality will fail.")
+# The HTML template remains the same
 HTML_TEMPLATE = """
 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>AI README Generator 🧠</title>
     <style>
         @import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700&display=swap');
         body { font-family: 'Inter', sans-serif; background-color: #f0f2f5; color: #1c1e21; margin: 0; display: flex; justify-content: center; align-items: center; min-height: 100vh; padding: 20px; box-sizing: border-box; }
 </head>
 <body>
     <div class="container">
+        <h1>AI README Generator 🧠</h1>
+        <p>Enter a public GitHub repository URL and let a true AI agent analyze the code and generate a README for you.</p>
         <form id="repo-form"><div class="input-group"><input type="url" id="repo-url" placeholder="e.g., https://github.com/user/project" required><button type="submit">Generate</button></div></form>
         <div class="loader" id="loader"></div>
         <div id="result-container"><h2>Generated README.md:</h2><pre id="result"></pre></div>
 </html>
 """
+def generate_readme_with_llm(repo_path):
     """
+    Analyzes the repo and uses an LLM to generate the README content.
     """
+    # 1. Gather context: file structure and content of key files
+    file_structure = ""
+    file_contents = ""
+    file_limit = 5  # Limit number of files to read to save tokens
+    for root, _, files in os.walk(repo_path):
+        # Ignore git directory
+        if '.git' in root:
+            continue
+        level = root.replace(repo_path, '').count(os.sep)
+        indent = ' ' * 4 * level
+        file_structure += f"{indent}{os.path.basename(root)}/\n"
+        sub_indent = ' ' * 4 * (level + 1)
+        for f in files[:file_limit]:
+            file_structure += f"{sub_indent}{f}\n"
+            # Read content of a few key files
+            try:
+                with open(os.path.join(root, f), 'r', errors='ignore') as file:
+                    content = file.read(2000) # Read first 2000 chars
+                    file_contents += f"\n--- Start of {f} ---\n{content}\n--- End of {f} ---\n"
+            except Exception:
+                continue # Skip files we can't read
+    # 2. Create a detailed prompt for the LLM
+    prompt = f"""
+    You are an expert technical writer tasked with creating a high-quality README.md for a GitHub repository.
+    Analyze the following repository context and generate a comprehensive and user-friendly README.
+    **Repository Context:**
+    **1. File Structure:**
+    ```
+    {file_structure}
+    ```
+    **2. Content of Key Files:**
+    ```
+    {file_contents}
+    ```
+    **Instructions:**
+    Based on the context provided, please generate a README.md file with the following sections:
+    1.  **Project Title:** An appropriate title for the project.
+    2.  **About the Project:** A concise but informative paragraph describing the project's purpose and the technology it uses. Infer this from the file contents.
+    3.  **Getting Started:** Clear, step-by-step instructions for installation and setup. Infer the package manager (pip, npm, etc.) and run commands.
+    4.  **Usage:** A simple example of how to run the application.
+    **Rules:**
+    - The output must be in valid Markdown format.
+    - Be professional and clear.
+    - If you cannot determine a piece of information (like a specific run command), suggest a common default and state that it might need to be verified.
+    - Do not invent features that are not evident from the provided context.
+    """
+    # 3. Call the LLM
+    print("Sending request to Gemini API...")
+    model = genai.GenerativeModel('gemini-1.5-flash-latest')
+    response = model.generate_content(prompt)
+    # Clean up the response - sometimes the model wraps it in ```markdown
+    readme_text = response.text.strip()
+    if readme_text.startswith("```markdown"):
+        readme_text = readme_text[10:]
+    if readme_text.endswith("```"):
+        readme_text = readme_text[:-3]
+    return readme_text
 @app.route('/')
 def index():
 @app.route('/generate', methods=['POST'])
 def generate():
     repo_url = request.get_json().get('url')
+    if not repo_url or not repo_url.startswith("[https://github.com/](https://github.com/)"):
         return jsonify({"error": "A valid GitHub repository URL is required."}), 400
+    if not os.environ.get("GOOGLE_API_KEY"):
+         return jsonify({"error": "Server is missing the GOOGLE_API_KEY. Cannot contact the LLM."}), 500
     temp_dir = tempfile.mkdtemp()
     try:
         git.Repo.clone_from(repo_url, temp_dir)
+        cloned_folders = [d for d in os.listdir(temp_dir) if os.path.isdir(os.path.join(temp_dir, d))]
         if not cloned_folders:
             raise Exception("Cloning seems to have failed, the directory is empty.")
         repo_root_path = os.path.join(temp_dir, cloned_folders[0])
+        # --- NEW: Call the LLM-powered function ---
+        readme_content = generate_readme_with_llm(repo_root_path)
         return jsonify({"readme": readme_content})
     except Exception as e:
+        return jsonify({"error": f"An error occurred: {str(e)}"}), 500
     finally:
         shutil.rmtree(temp_dir)
 if __name__ == '__main__':