Function generate_markdown_documentation

app.py:448–499

Generate an enhanced Markdown documentation file (DOCUMENTATION.md) using the AI model. Args: client (Groq): The AI client instance. model_name (str): The model name to use. package_structure (Dict[str, str]): Dictionary mapping file paths to their contents.

(client: Groq, model_name: str, package_structure: Dict[str, str], package_name: str, max_retries: int = 5)

    return zip_buffer.getvalue()

def generate_markdown_documentation(client: Groq, model_name: str, package_structure: Dict[str, str], package_name: str, max_retries: int = 5) -> Optional[str]:
    """
    Generate an enhanced Markdown documentation file (DOCUMENTATION.md) using the AI model.

    Args:
        client (Groq): The AI client instance.
        model_name (str): The model name to use.
        package_structure (Dict[str, str]): Dictionary mapping file paths to their contents.
        package_name (str): Name of the Python package.
        max_retries (int): Maximum number of retries for the request.

    Returns:
        Optional[str]: The content of the generated DOCUMENTATION.md file or None if failed.
    """
    # Prepare the prompt
    prompt = f"""
You are to generate comprehensive documentation for a Python package named '{package_name}'. The package contains the following files and their contents:

"""

    for file_path, content in package_structure.items():
        prompt += f"File: {file_path}\nContent:\n\"\"\"\n{content}\n\"\"\"\n\n"

    prompt += f"""
Based on the above files and their contents, generate detailed and user-friendly documentation in Markdown format. The documentation should include an overview, installation instructions, usage examples, API references, and any other relevant sections that would help users understand and utilize the package effectively. Do not include any code that is not part of the package. Ensure the documentation is well-structured and written in clear, professional language. Be and act like technical writer. Try to be verbose as much as possible. Write the documentation in a tutorial like style and explain how to use each file.

Begin the documentation below:
"""

    retries = 0
    while retries < max_retries:
        try:
            response = client.chat.completions.create(
                messages=[
                    {
                        "role": "user",
                        "content": prompt.strip(),
                    }
                ],
                model=model_name,
            )
            documentation_content = response.choices[0].message.content.strip()
            return documentation_content
        except Exception as e:
            retries += 1
            wait_time = 2 ** retries
            print(f"Error generating documentation: {str(e)}")
            print(f"Retrying in {wait_time} seconds... (Attempt {retries}/{max_retries})")
            time.sleep(wait_time)
    else:
        print(f"Failed to generate documentation after {max_retries} attempts.")
        return None

def main():
    st.set_page_config(page_title="🛠️ PyGen", layout="wide")