Llama-github Initial Release v0.1.0

[JetXu-LLM]

We are excited to announce the initial release of llama-github!

Llama-github is an open-source Python library that empowers LLM Chatbots, AI Agents, and Auto-dev Agents to conduct Retrieval from actively selected GitHub public contents (Repository, Issue, Code). It Augments through LLMs and Generates context for any coding question, in order to streamline the development of sophisticated AI-driven applications.

Highlights:

• Intelligent GitHub Retrieval: Retrieve highly relevant code snippets, issues, and repository information from GitHub based on user queries.
• Repository Pool Caching: Innovative caching mechanism that stores repositories across threads, significantly accelerating GitHub search retrieval efficiency and minimizing GitHub API token consumption.
• LLM-Powered Question Analysis: Leverage state-of-the-art language models to analyze user questions and generate effective search strategies and criteria.
• Comprehensive Context Generation: Generate rich, contextually relevant answers by combining information from GitHub with advanced language model reasoning capabilities.
• Asynchronous Processing Excellence: Handle multiple requests concurrently with meticulously implemented asynchronous mechanisms, boosting overall performance.
• Flexible LLM Integration: Easily integrate with various LLM providers, embedding models, and reranking models to customize the library's capabilities.
• Robust Authentication Options: Support both personal access tokens and GitHub App authentication for flexible integration into different development setups.
• Logging and Error Handling: Equipped with comprehensive logging and error handling mechanisms for smooth operations and easy troubleshooting.

Installation

pip install llama-github

Usage

Here's a simple example of how to use llama-github:

from llama_github import GithubRAG

# Initialize GithubRAG with your credentials
github_rag = GithubRAG(
    github_access_token="your_github_access_token", 
    openai_api_key="your_openai_api_key", # Optional in Simple Mode
    jina_api_key="your_jina_api_key" # Optional - unless you want high concurrency production deployment (s.jina.ai API will be used in llama-github)
)

# Retrieve context for a coding question (simple_mode is default set to False)
query = "How to create a NumPy array in Python?"
context = github_rag.retrieve_context(
    query, # In professional mode, one query will take nearly 1 min to generate final contexts. You could set log level to INFO to monitor the retrieval progress
    # simple_mode = True
)

### Documentation:

For detailed documentation, please visit our [GitHub repository](https://github.com/JetXu-LLM/llama-github).

### Feedback:

We welcome feedback and contributions from the community. Please feel free to open issues or pull requests.

Thank you for using **llama-github**!


<hr /><em>This discussion was created from the release <a href='https://github.com/JetXu-LLM/llama-github/releases/tag/v0.1.10'>Llama-github Initial Release v0.1.0</a>.</em>