GithubAPIWrapper throws list index out of range error

[usamasaleem1]

System Info

Name: langchain
Version: 0.0.348

Name: PyGithub
Version: 2.1.1

Who can help?

Harrison Chase (@hwchase17)
Ankush Gola (@agola11)

Traceback (most recent call last):
  File "/Users/mac/Dev Projects/Chainlit_qa/test.py", line 12, in <module>
    github = GitHubAPIWrapper(
             ^^^^^^^^^^^^^^^^^
  File "/Users/mac/Dev Projects/Chainlit_qa/myenv/lib/python3.11/site-packages/pydantic/v1/main.py", line 339, in __init__
    values, fields_set, validation_error = validate_model(__pydantic_self__.__class__, data)
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/mac/Dev Projects/Chainlit_qa/myenv/lib/python3.11/site-packages/pydantic/v1/main.py", line 1102, in validate_model
    values = validator(cls_, values)
             ^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/mac/Dev Projects/Chainlit_qa/myenv/lib/python3.11/site-packages/langchain/utilities/github.py", line 69, in validate_environment
    installation = gi.get_installations()[0]
                   ~~~~~~~~~~~~~~~~~~~~~~^^^
  File "/Users/mac/Dev Projects/Chainlit_qa/myenv/lib/python3.11/site-packages/github/PaginatedList.py", line 62, in __getitem__
    return self.__elements[index]
           ~~~~~~~~~~~~~~~^^^^^^^
IndexError: list index out of range

Information

• The official example notebooks/scripts
• My own modified scripts

Related Components

• LLMs/Chat Models
• Embedding Models
• Prompts / Prompt Templates / Prompt Selectors
• Output Parsers
• Document Loaders
• Vector Stores / Retrievers
• Memory
• Agents / Agent Executors
• Tools / Toolkits
• Chains
• Callbacks/Tracing
• Async

Reproduction

Run basic python file:

from langchain.agents.agent_toolkits.github.toolkit import GitHubToolkit
from langchain.utilities.github import GitHubAPIWrapper

github = GitHubAPIWrapper()
toolkit = GitHubToolkit.from_github_api_wrapper(github)
tools = toolkit.get_tools()

Expected behavior

Fetching github repository information

[dosubot]

🤖

Hello Usama Saleem (@usamasaleem1)!

I'm Dosu, a friendly bot here to assist you with bugs, help answer your questions, and guide you on becoming a contributor. While we're waiting for a human maintainer to join us, I'm all ears for your needs! Let's turn those bugs into features together. 😄

The error you're encountering is due to the line installation = gi.get_installations()[0] in the validate_environment method of the GitHubAPIWrapper class. This line is trying to access the first element of the list returned by get_installations(). The "list index out of range" error is thrown when the list is empty, which means no installations were found.

This could be due to a few reasons:

1. The GitHub App ID and private key provided are incorrect or do not correspond to an app with installations.
2. The app does have installations, but none of them are accessible with the provided API key.

To resolve this issue, you should first verify that your GitHub App ID and private key are correct and correspond to an app with installations. You should also ensure that the API key you're using has the necessary permissions to access these installations.

If you're still encountering this issue after verifying these details, it would be helpful to add some error handling and logging to the validate_environment method to provide more information about the error. For example:

def validate_environment(cls, values):
    try:
        gi = GitHubIntegration(values['github_app_id'], values['github_app_private_key'])
        installation = gi.get_installations()[0]
    except IndexError:
        raise ValueError("No installations found for the provided GitHub App ID and private key.")
    except Exception as e:
        raise ValueError(f"An error occurred while validating the environment: {str(e)}")
    ...

This will raise a more descriptive error when no installations are found, and will also catch and provide information about any other exceptions that occur during the validation process.

Please let me know if this helps or if you need further assistance.

Sources

• libs/langchain/langchain/utilities/github.py

---

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with Dosu Bot (@dosu-bot).

[usamasaleem1]

Still same error while logging validate_environment, made sure all env variables are set also

[keenborder786]

Let me see.

[keenborder786]

I have created a PR for this but just to clarify , in order to use the wrapper for your repo, you need to make sure that you have installed the app on the repo. Please see Repository access in your app configuration and make sure to install the app on the repo.

[usamasaleem1]

I have created a PR for this but just to clarify , in order to use the wrapper for your repo, you need to make sure that you have installed the app on the repo. Please see Repository access in your app configuration and make sure to install the app on the repo.

Thanks, i've done that, and now I get this error:

2023-12-12 12:03:41 - 1 validation error for GitHubAPIWrapper
__root__
  An error occurred while validating the environment: name 'GitHubIntegration' is not defined (type=value_error)
Traceback (most recent call last):
  File "/Users/mac/Dev Projects/Chainlit_qa/myenv/lib/python3.11/site-packages/chainlit/utils.py", line 41, in wrapper
    return user_function(**params_values)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/mac/Dev Projects/Chainlit_qa/chainlit_app.py", line 106, in start
    github = GitHubAPIWrapper()
             ^^^^^^^^^^^^^^^^^^
  File "/Users/mac/Dev Projects/Chainlit_qa/myenv/lib/python3.11/site-packages/pydantic/v1/main.py", line 341, in __init__
    raise validation_error
pydantic.v1.error_wrappers.ValidationError: 1 validation error for GitHubAPIWrapper
__root__
  An error occurred while validating the environment: name 'GitHubIntegration' is not defined (type=value_error)

[keenborder786]

Make sure to install PyGithub:

pip install PyGithub

Can you please more of your code so that I can help you better because this does not seem problem with langchain.

[usamasaleem1]

Make sure to install PyGithub:

pip install PyGithub

Can you please more of your code so that I can help you better because this does not seem problem with langchain.

I found the issue. I just didn't set the permissions for my APi to the full scope lol.

[triThirty]

Hi Mohammad Mohtashim (@keenborder786) ,
I got this error

Traceback (most recent call last):
  File "/Users/Downloads/archive/ai/main.py", line 28, in <module>
    github = GitHubAPIWrapper()
             ^^^^^^^^^^^^^^^^^^
  File "/Users/Downloads/archive/venv/lib/python3.11/site-packages/pydantic/v1/main.py", line 341, in __init__
    raise validation_error
pydantic.v1.error_wrappers.ValidationError: 1 validation error for GitHubAPIWrapper
__root__
  ('Could not deserialize key data. The data may be in an incorrect format, it may be encrypted with an unsupported algorithm, or it may be an unsupported key type (e.g. EC curves with explicit parameters).', [<OpenSSLError(code=75497580, lib=9, reason=108, reason_text=no start line)>]) (type=value_error)

I am not sure github = GitHubAPIWrapper() is ok, cause I found github and github_repo_instance are mandatory.
But I am confused because both values would be set here. So could you give me some clue? Thanks

Whole code looks like:

import os
from langchain.utilities.github import GitHubAPIWrapper

os.environ["GITHUB_APP_ID"] = "1111"
os.environ["GITHUB_APP_PRIVATE_KEY"] = "xxxxxxxx"
os.environ["GITHUB_REPOSITORY"] = "xx/xxx"
os.environ["GITHUB_BRANCH"] = "main"
os.environ["GITHUB_BASE_BRANCH"] = "main"
github = GitHubAPIWrapper()

The lib version:

aiohttp==3.9.1
aiosignal==1.3.1
annotated-types==0.6.0
anyio==4.2.0
attrs==23.1.0
certifi==2023.11.17
cffi==1.16.0
charset-normalizer==3.3.2
cryptography==41.0.7
dataclasses-json==0.6.3
Deprecated==1.2.14
fireworks-ai==0.10.0
frozenlist==1.4.1
greenlet==3.0.3
h11==0.14.0
httpcore==1.0.2
httpx==0.26.0
httpx-sse==0.3.1
idna==3.6
jsonpatch==1.33
jsonpointer==2.4
langchain==0.0.352
langchain-community==0.0.6
langchain-core==0.1.3
langsmith==0.0.74
marshmallow==3.20.1
multidict==6.0.4
mypy-extensions==1.0.0
numpy==1.26.2
packaging==23.2
Pillow==10.1.0
pycparser==2.21
pydantic==2.5.2
pydantic_core==2.14.5
PyGithub==2.1.1
PyJWT==2.8.0
PyNaCl==1.5.0
python-dateutil==2.8.2
PyYAML==6.0.1
requests==2.31.0
six==1.16.0
sniffio==1.3.0
SQLAlchemy==2.0.23
tenacity==8.2.3
typing-inspect==0.9.0
typing_extensions==4.9.0
urllib3==2.1.0
wrapt==1.16.0
yarl==1.9.4