import os
import shutil
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 = """
GitHub README Generator
GitHub README Generator 💻
Enter a public GitHub repository URL and let the AI agent generate a professional README.md for you.
"""
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 \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():
return render_template_string(HTML_TEMPLATE)
@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__':
app.run(host='0.0.0.0', port=int(os.environ.get("PORT", 7860)))