"invalid_api_key"

[Kisiel75311]

Hi, I've encountered a problem, I'm using api_key, which I also use elsewhere with no problem, whereas in this case something is not working: 2023-05-21 21:46:38 | ERROR | logger:error:41 - Error fetching summary for src\main\java\com\electronicTicket\config\AppConfig.java: { "error": { "message": "", "type": "invalid_request_error", "param": null, "code": "invalid_api_key" } }

[eli64s]

Hi @Kisiel75311 thanks for letting me know.

Did you try creating a new OpenAI API key? If not, I would suggest generating a new key and exporting to your environment as follows:

export OPENAI_API_KEY=newkey123456789

Let me know if this corrects the issue, or if it may be something else.

Thanks,
Eli

[Kisiel75311]

It was some problem just running 'export' on windows, but now I have another one:
Usage: main.py [OPTIONS].
Try 'main.py --help' for help.

Error: No such option: --api_key Did you mean --api-key?

Where looking in the code is "api_key", not "api-key"

    with tempfile.TemporaryDirectory() as tmp_dir:
        repo_path = Path(tmp_dir) / "repo"

        try:
            git.Repo.clone_from(url, repo_path)

            # Replace "tree" command with Windows equivalent "dir /s /b"
            if os.name == 'nt':  # If the OS is Windows.
                tree_bytes = subprocess.check_output(["cmd", "/c", "dir /s /b", str(repo_path)], shell=True)
            else:  # Non-Windows.
                tree_bytes = subprocess.check_output(["tree", "-n", repo_path])

            tree_str = tree_bytes.decode("utf-8")
            tree_lines = tree_str.split("\n")[1:]
            tree_str = "\n".join(tree_lines)
            if os.name == 'nt':
                tree_md = f"```cmd\n{repo_path.name}\n{tree_str}```"
                return tree_md
            else:
                tree_md = f"```bash\n{repo_path.name}\n{tree_str}```"
                return tree_md

I add some code to fix that, but it doesnt work anyways :/

[eli64s]

Can you share the full command you enter to run the program?

[Kisiel75311]

python src/main.py --output README_AI.md --repository https://github.com/eli64s/README-AI

[eli64s]

Thanks, that looks correct.

Are you getting a new error message after exporting the new API key?

[Kisiel75311]

Same, I tried bash scripts/run.sh in gitbash, with this conf:

[api]
api_key = "sk-myApiKey"
prompt_intro = """Generate a 2 to 3 sentence summary that describes the capabilities of the GitHub project: {}"""
prompt_slogan = """Generate a slogan for the GitHub project: {}"""
prompt_code_to_text = """Generate a robust, yet succint summary for this code: {}"""

# Repository (local and remote)
[git]
name = ""
repository = "https://github.com/Kisiel75311/eTicket"

but get:

Kisiela@aps00095977-mb MINGW64 ~/Desktop/ReadmeAI/Nowy folder/README-AI (main)
$ bash scripts/run.sh
Error: Invalid or missing repository URL or path.

in powershell i get:

2023-05-21 23:34:37 | WARNING | logger:warning:38 - Error creating directory tree: [WinError 2] The system cannot find the file specified

[eli64s]

I assume you have the latest README-AI repository cloned. If so let's try a change on your end.

Update main.py on your machine with the following code. Then re-run the bash scripts/run.sh command.

"""Generates README.md file for your repository using OpenAI's GPT APIs."""

import asyncio
import os
from pathlib import Path
from typing import Optional

import dacite
import openai
import pandas as pd
import typer

import builder
import model
import preprocess
from conf import AppConfig, load_configuration_helper
from factory import FileHandler
from logger import Logger

app = typer.Typer()
CONF = Path("conf/conf.toml")
LOGGER = Logger("readmeai_logger")


def set_openai_api_key(api_key: Optional[str]) -> str:
    """Validates and sets the OpenAI API key provided by the user."""
    if api_key is None:
        api_key = os.environ.get("OPENAI_API_KEY")
    if api_key is None:
        typer.echo("Error: Invalid or missing OpenAI API key.")
        raise typer.Exit(code=1)
    return api_key


def validate_repository(repository: Optional[str], conf: AppConfig) -> str:
    """Validates the repository URL or path provided by the user."""
    if repository is None:
        repository = conf.git.repository
    if repository is None or (
        not repository.startswith("http") and not Path(repository).exists()
    ):
        typer.echo("Error: Invalid or missing repository URL or path.")
        raise typer.Exit(code=1)
    return repository


def get_configuration(config_path: str) -> AppConfig:
    """Load README-AI configuration from TOML file."""
    handler = FileHandler()
    conf_dict = handler.read(config_path)
    return dacite.from_dict(AppConfig, conf_dict)


@app.command()
def main(
    api_key: Optional[str] = typer.Option(None, help="Your OpenAI API key."),
    output: str = typer.Option(
        "README_AI.md", help="Path to your README file."
    ),
    repository: Optional[str] = typer.Option(
        None, help="Repository url or path."
    ),
) -> None:
    api_key = set_openai_api_key(api_key)
    openai.api_key = api_key

    conf = get_configuration(CONF)
    
    repository = validate_repository(repository, conf)

    asyncio.run(generate_readme(output, repository, conf))


async def generate_readme(output: str, repository: str, conf: AppConfig) -> None:
    """Generate README.md file for your repository using OpenAI's GPT APIs."""
    LOGGER.info("README-AI is now executing.")

    conf_helper = load_configuration_helper(conf)

    conf.paths.md = output
    conf.git.repository = repository
    conf.git.name = preprocess.get_repository_name(repository)
    file_contents = preprocess.get_repository(repository)
    dependency_list = preprocess.extract_dependencies(
        conf_helper.dependency_files, conf_helper.language_names, repository
    )

    LOGGER.info(f"Total files to document: {len(file_contents)}")
    LOGGER.info(f"\nProject dependencies list: {dependency_list}\n")

    summaries = await llm_text_gen(
        conf, file_contents, conf_helper.ignore_files
    )
    summaries = pd.DataFrame(summaries, columns=["Module", "Summary"])
    summaries.to_csv(conf.paths.docs, index=False)

    LOGGER.info(f"OpenAI LLM generated code summaries:\n\n{summaries}\n")

    builder.build(conf, conf_helper, dependency_list, summaries)

    LOGGER.info("README-AI execution complete.\n")


async def llm_text_gen(
    conf: AppConfig, file_contents: list, ignore_files: list
) -> list:
    """Generate summary text for code files using OpenAI's GPT-3."""
    name = conf.git.name
    prompt_intro = conf.api.prompt_intro
    prompt_slogan = conf.api.prompt_slogan
    prompt_code = conf.api.prompt_code_to_text
    code_summaries = await model.code_to_text(
        ignore_files, file_contents, prompt_code
    )
    intro = model.generate_summary_text(prompt_intro.format(name))
    slogan = model.generate_summary_text(prompt_slogan.format(name))
    conf.md.intro = conf.md.intro.format(intro)
    conf.md.slogan = conf.md.slogan.format(slogan)

    return code_summaries


if __name__ == "__main__":
    app()

Let me know if this works for you. Thanks for the patience.

Eli

[Kisiel75311]

Still the same, but I booted myself up on cloud where I have ubuntu and it works. Thanks for the quick reply even though the problem was not solved

[eli64s]

Cool, I'm glad you got it to work 👍

Thanks for bringing this to my attention, I'll work on getting the tool working consistently across all systems!