langchain_community.document_loaders.github.GithubFileLoader

class langchain_community.document_loaders.github.GithubFileLoader

Bases: BaseGitHubLoader, ABC

Load GitHub File

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param access_token: str [Required]

Personal access token - see https://github.com/settings/tokens?type=beta

param branch: str = 'main'

param file_filter: Optional[Callable[[str], bool]] = None

param github_api_url: str = 'https://api.github.com'

URL of GitHub API

param repo: str [Required]

Name of repository

async alazy_load() → AsyncIterator[Document]

A lazy loader for Documents.

Return type

AsyncIterator[Document]

async aload() → List[Document]

Load data into Document objects.

Return type

List[Document]

get_file_content_by_path(path: str) → str

Parameters

path (str) –

Return type

str

get_file_paths() → List[Dict]

Return type

List[Dict]

lazy_load() → Iterator[Document]

A lazy loader for Documents.

Return type

Iterator[Document]

load() → List[Document]

Load data into Document objects.

Return type

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]

Load Documents and split into chunks. Chunks are returned as Documents.

Do not override this method. It should be considered to be deprecated!

Parameters

text_splitter (Optional[TextSplitter]) – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

Returns

List of Documents.

Return type

List[Document]

property headers: Dict[str, str]

Examples using GithubFileLoader

• GitHub