llama-github 0.3.3__tar.gz → 0.4.0__tar.gz

{llama_github-0.3.3 → llama_github-0.4.0}/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2026-03-25
+
+### Changed
+- Modernized packaging to `pyproject.toml` and raised the runtime floor to Python 3.10+
+- Reworked LLM and GitHub integration layers to reduce stale compatibility paths and deprecated APIs
+- Updated repository retrieval docs to reflect the actual return shapes and maintenance-focused project positioning
+
+### Fixed
+- Corrected `simple_mode` behavior so it no longer depends on embedding and reranker initialization
+- Fixed message composition order for chat history vs context handling
+- Stabilized test execution and added runnable mock/real examples
+
 ## [0.3.3] - 2025-08-24
 
 ### Optimized

{llama_github-0.3.3/llama_github.egg-info → llama_github-0.4.0}/PKG-INFO

@@ -1,36 +1,40 @@
 Metadata-Version: 2.4
 Name: llama-github
-Version: 0.3.3
-Summary: 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 projects. It Augments through LLMs and Generates context for any coding question, in order to streamline the development of sophisticated AI-driven applications.
-Home-page: https://github.com/JetXu-LLM/llama-github
-Author: Jet Xu
-Author-email: Voldemort.xu@foxmail.com
+Version: 0.4.0
+Summary: GitHub retrieval and context generation utilities for coding assistants and AI developer workflows.
+Author-email: Jet Xu <Voldemort.xu@foxmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/JetXu-LLM/llama-github
+Project-URL: Repository, https://github.com/JetXu-LLM/llama-github
+Project-URL: Issues, https://github.com/JetXu-LLM/llama-github/issues
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp
-Requires-Dist: asyncio
-Requires-Dist: PyGithub
-Requires-Dist: langchain
-Requires-Dist: numpy
-Requires-Dist: pydantic
-Requires-Dist: requests
-Requires-Dist: transformers
-Requires-Dist: urllib3
-Requires-Dist: pydantic_core
-Requires-Dist: langchain_openai
-Requires-Dist: langchain_mistralai
-Requires-Dist: httpx_sse
-Requires-Dist: tokenizers
+Requires-Dist: PyGithub<3,>=2.4
+Requires-Dist: aiohttp<4,>=3.9
+Requires-Dist: ipython<9,>=8
+Requires-Dist: langchain-core<0.4,>=0.3.30
+Requires-Dist: langchain-mistralai<0.3,>=0.2
+Requires-Dist: langchain-openai<0.4,>=0.3.0
+Requires-Dist: langchain-text-splitters<0.4,>=0.3.0
+Requires-Dist: nest-asyncio<2,>=1.6
+Requires-Dist: numpy<3,>=1.24
+Requires-Dist: pydantic<3,>=2.10
+Requires-Dist: python-dateutil<3,>=2.9
+Requires-Dist: requests<3,>=2.31
+Requires-Dist: tokenizers<1,>=0.20
+Requires-Dist: transformers<6,>=4.47
+Requires-Dist: urllib3<3,>=2
 Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
+Requires-Dist: build<2,>=1.2; extra == "dev"
+Requires-Dist: pytest<9,>=8.3; extra == "dev"
+Requires-Dist: pytest-asyncio<1,>=0.25; extra == "dev"
 Dynamic: license-file
-Dynamic: requires-dist
 
 
 <div align="right">
@@ -58,7 +62,6 @@ Dynamic: requires-dist
         | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=tr">Türkçe</a>
         | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=vi">Tiếng Việt</a>
         | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=id">Bahasa Indonesia</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=as">অসমীয়া</
       </div>
     </div>
   </details>
@@ -84,6 +87,8 @@ If you like this project or believe it has potential, please give it a ⭐️. Y
 pip install llama-github
 ```
 
+Current maintained runtime target: Python `3.10+`.
+
 ## Usage
 
 Here's a simple example of how to use llama-github:
@@ -100,29 +105,32 @@ github_rag = GithubRAG(
 
 # 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
+contexts = github_rag.retrieve_context(
+    query,
     # simple_mode = True
 )
 
-print(context)
+print(contexts[0]["url"])
+print(contexts[0]["context"])
 ```
 
-For more advanced usage and examples, please refer to the [documentation](docs/usage.md).
+`retrieve_context()` returns a list of context dictionaries. Each item contains at least `context` and `url`.
+
+For more advanced usage and examples, please refer to the [documentation](docs/usage.md). Runnable low-cost examples are also available in [`examples/`](examples).
 
 ## Key Features
 
 - **🔍 Intelligent GitHub Retrieval**: Harness the power of llama-github to retrieve highly relevant code snippets, issues, and repository information from GitHub based on user queries. Our advanced retrieval techniques ensure you find the most pertinent information quickly and efficiently.
 
-- **⚡ Repository Pool Caching**: Llama-github has an innovative repository pool caching mechanism. By caching repositories (including READMEs, structures, code, and issues) across threads, llama-github significantly accelerates GitHub search retrieval efficiency and minimizes the consumption of GitHub API tokens. Deploy llama-github in multi-threaded production environments with confidence, knowing that it will perform optimally and save you valuable resources.
+- **⚡ Repository Pool Caching**: Llama-github has an innovative repository pool caching mechanism. By caching repositories (including READMEs, structures, code, and issues) across threads, llama-github significantly accelerates GitHub search retrieval efficiency and minimizes the consumption of GitHub API tokens.
 
 - **🧠 LLM-Powered Question Analysis**: Leverage state-of-the-art language models to analyze user questions and generate highly effective search strategies and criteria. Llama-github intelligently breaks down complex queries, ensuring that you retrieve the most relevant information from GitHub's vast repository network.
 
 - **📚 Comprehensive Context Generation**: Generate rich, contextually relevant answers by seamlessly combining information retrieved from GitHub with the reasoning capabilities of advanced language models. Llama-github excels at handling even the most complex and lengthy questions, providing comprehensive and insightful responses that include extensive context to support your development needs.
 
-- **🚀 Asynchronous Processing Excellence**: Llama-github is built from the ground up to leverage the full potential of asynchronous programming. With meticulously implemented asynchronous mechanisms woven throughout the codebase, llama-github can handle multiple requests concurrently, significantly boosting overall performance. Experience the difference as llama-github efficiently manages high-volume workloads without compromising on speed or quality.
+- **🚀 Asynchronous Processing Excellence**: Llama-github is built from the ground up to leverage the full potential of asynchronous programming. With meticulously implemented asynchronous mechanisms woven throughout the codebase, llama-github can handle multiple requests concurrently, significantly boosting overall performance.
 
-- **🔧 Flexible LLM Integration**: Easily integrate llama-github with various LLM providers, embedding models, and reranking models to tailor the library's capabilities to your specific requirements. Our extensible architecture allows you to customize and enhance llama-github's functionality, ensuring that it adapts seamlessly to your unique development environment.
+- **🔧 Flexible LLM Integration**: Easily integrate llama-github with various LLM providers, embedding models, reranking models, or an injected LangChain-compatible chat model to tailor the library's capabilities to your specific requirements.
 
 - **🔒 Robust Authentication Options**: Llama-github supports both personal access tokens and GitHub App authentication, providing you with the flexibility to integrate it into different development setups. Whether you're an individual developer or working within an organizational context, llama-github has you covered with secure and reliable authentication mechanisms.
 
@@ -154,7 +162,7 @@ Our vision is to become a pivotal module in the future of AI-driven development
 
 ### Roadmap
 
-For a detailed view of our project roadmap, please visit our [Project Roadmap](https://github.com/users/JetXu-LLM/projects/2).
+For a historical view of the earlier roadmap, please visit [Vision and Roadmap](VISION_AND_ROADMAP.md).
 
 ## Acknowledgments
 
@@ -180,155 +188,3 @@ If you have any questions, suggestions, or feedback, please feel free to reach o
 ---
 
 Thank you for choosing llama-github! We hope this library enhances your AI development experience and helps you build powerful applications with ease.
-
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [0.3.3] - 2025-08-24
-
-### Optimized
-- Enhance diff hunk header
-
-## [0.3.2] - 2025-06-23
-
-### Optimized
-- Upgrade to extract_related_issues method
-
-## [0.3.1] - 2025-05-25
-
-### Optimized
-- Upgrade to mistral medium & devstral small
-
-## [0.2.8] - 2025-03-19
-
-### Optimized
-- Upgrade to mistral-small-latest
-
-## [0.2.3] - 2024-11-24
-
-### Optimized
-- Upgrade to mistral-large-2411
-
-## [0.2.2] - 2024-11-19
-
-### Optimized
-- more precise model specification (stick to mistral-large-2407 and mistral-nemo-latest)
-
-## [0.2.1] - 2024-11-16
-
-### Optimized
-- approperately handle more file types when calculate file changes in PR
-
-## [0.2.0] - 2024-11-16
-
-### Optimized
-- fix bugs for generate repo from pool by using Github_install_id
-
-## [0.1.9] - 2024-11-04
-
-### Optimized
-- fix bugs for get pr content
-
-## [0.1.8] - 2024-11-03
-
-### Optimized
-- fix bugs for get pr content file diff calculate logic
-
-## [0.1.7] - 2024-10-31
-
-### Optimized
-- fix bugs for get pr content
-
-## [0.1.6] - 2024-10-30
-
-### New Features
-- Enhanced PR content analysis with detailed commit information extraction
-- Improved issue linking detection with support for multiple reference formats
-  - Full GitHub URLs, #references, and keyword-based references
-  - Added validation for issue numbers
-
-### Improvements
-- Added detailed commit metadata extraction including stats and file changes
-- Enhanced error handling for commit fetching
-
-## [0.1.5] - 2024-10-14
-
-### Optimized
-- requirements.txt updated to more precise list
-
-## [0.1.4] - 2024-10-14
-
-### Improved
-- Optimized `simple_mode`:
-  - Removed dependencies on `Torch` and `Transformers` libraries
-  - Reduced memory footprint
-  - Eliminated related imports
-  - Enhanced compatibility with AWS Lambda environment
-
-## [0.1.3] - 2024-10-14
-
-### Added
-- Modified `LLMManager` class to skip loading embedding and reranker models when `simple_mode` is enabled
-- Updated `retrieve_context` method to use instance's `simple_mode` by default, with option to override
-
-### Improved
-- Faster initialization process when `simple_mode` is enabled, skipping embedding and reranker model loading
-- More flexible usage of `simple_mode` in `retrieve_context`, allowing per-call customization
-
-### Developer Notes
-- When using `simple_mode=True` during GithubRAG initialization, be aware that embedding and reranking functionalities will not be available
-- The `retrieve_context` method now uses a late binding approach for `simple_mode` parameter
-
-## [0.1.2] - 2024-10-09
-
-### Added
-- New `get_pr_content` method in `Repository` class for comprehensive PR data retrieval
-- Singleton pattern implementation for efficient PR data caching
-- Support for LLM-assisted PR analysis and Q&A capabilities
-- Automatic caching mechanism to reduce API calls and improve performance
-- Threaded comment and review retrieval functionality
-
-### Changed
-- Improved PR data fetching process to include metadata, file changes, and comments
-
-### Optimized
-- Reduced API calls through intelligent caching of PR data
-
-### Developer Notes
-- First call to `get_pr_content` fetches data from GitHub API, subsequent calls use cached data
-- Cache automatically refreshes when PR is updated
-
-## [0.1.1] - 2024-08-23
-
-### Added
-- Implemented `answer_with_context` method for direct answer generation (closes #6)
-- Added support for Mistral AI LLM provider
-- Enhanced `retrieve_context` function to include metadata (e.g., URLs) with each context string (closes #2)
-
-### Changed
-- Improved reranking with jina-reranker-v2 for better context retrieval
-- Updated return type of `retrieve_context` to accommodate metadata
-
-### Fixed
-- Resolved warning during context retrieval (closes #3)
-
-### Improved
-- Enhanced overall context retrieval process
-- Expanded LLM support for more versatile use cases
-
-## [0.1.0] - 2024-08-15
-
-### Added
-- Initial release of llama-github
-- Basic functionality for retrieving context from GitHub repositories
-- Integration with LLM for processing and generating responses
-
-[0.1.4]: https://github.com/JetXu-LLM/llama-github/compare/v0.1.3...v0.1.4
-[0.1.3]: https://github.com/JetXu-LLM/llama-github/compare/v0.1.2...v0.1.3
-[0.1.2]: https://github.com/JetXu-LLM/llama-github/compare/v0.1.1...v0.1.2
-[0.1.1]: https://github.com/JetXu-LLM/llama-github/compare/v0.1.0...v0.1.1
-[0.1.0]: https://github.com/JetXu-LLM/llama-github/releases/tag/v0.1.0

{llama_github-0.3.3 → llama_github-0.4.0}/README.md

@@ -1,33 +1,32 @@
-
-<div align="right">
-  <details>
-    <summary >🌐 Language</summary>
-    <div>
-      <div align="center">
-        <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=en">English</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=zh-CN">简体中文</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=zh-TW">繁體中文</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=ja">日本語</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=ko">한국어</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=hi">हिन्दी</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=th">ไทย</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=fr">Français</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=de">Deutsch</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=es">Español</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=it">Italiano</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=ru">Русский</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=pt">Português</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=nl">Nederlands</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=pl">Polski</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=ar">العربية</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=fa">فارسی</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=tr">Türkçe</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=vi">Tiếng Việt</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=id">Bahasa Indonesia</a>
-        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=as">অসমীয়া</
-      </div>
-    </div>
-  </details>
+
+<div align="right">
+  <details>
+    <summary >🌐 Language</summary>
+    <div>
+      <div align="center">
+        <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=en">English</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=zh-CN">简体中文</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=zh-TW">繁體中文</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=ja">日本語</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=ko">한국어</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=hi">हिन्दी</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=th">ไทย</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=fr">Français</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=de">Deutsch</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=es">Español</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=it">Italiano</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=ru">Русский</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=pt">Português</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=nl">Nederlands</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=pl">Polski</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=ar">العربية</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=fa">فارسی</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=tr">Türkçe</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=vi">Tiếng Việt</a>
+        | <a href="https://openaitx.github.io/view.html?user=JetXu-LLM&project=llama-github&lang=id">Bahasa Indonesia</a>
+      </div>
+    </div>
+  </details>
 </div>
 
 # llama-github
@@ -50,6 +49,8 @@ If you like this project or believe it has potential, please give it a ⭐️. Y
 pip install llama-github
 ```
 
+Current maintained runtime target: Python `3.10+`.
+
 ## Usage
 
 Here's a simple example of how to use llama-github:
@@ -66,29 +67,32 @@ github_rag = GithubRAG(
 
 # 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
+contexts = github_rag.retrieve_context(
+    query,
     # simple_mode = True
 )
 
-print(context)
+print(contexts[0]["url"])
+print(contexts[0]["context"])
 ```
 
-For more advanced usage and examples, please refer to the [documentation](docs/usage.md).
+`retrieve_context()` returns a list of context dictionaries. Each item contains at least `context` and `url`.
+
+For more advanced usage and examples, please refer to the [documentation](docs/usage.md). Runnable low-cost examples are also available in [`examples/`](examples).
 
 ## Key Features
 
 - **🔍 Intelligent GitHub Retrieval**: Harness the power of llama-github to retrieve highly relevant code snippets, issues, and repository information from GitHub based on user queries. Our advanced retrieval techniques ensure you find the most pertinent information quickly and efficiently.
 
-- **⚡ Repository Pool Caching**: Llama-github has an innovative repository pool caching mechanism. By caching repositories (including READMEs, structures, code, and issues) across threads, llama-github significantly accelerates GitHub search retrieval efficiency and minimizes the consumption of GitHub API tokens. Deploy llama-github in multi-threaded production environments with confidence, knowing that it will perform optimally and save you valuable resources.
+- **⚡ Repository Pool Caching**: Llama-github has an innovative repository pool caching mechanism. By caching repositories (including READMEs, structures, code, and issues) across threads, llama-github significantly accelerates GitHub search retrieval efficiency and minimizes the consumption of GitHub API tokens.
 
 - **🧠 LLM-Powered Question Analysis**: Leverage state-of-the-art language models to analyze user questions and generate highly effective search strategies and criteria. Llama-github intelligently breaks down complex queries, ensuring that you retrieve the most relevant information from GitHub's vast repository network.
 
 - **📚 Comprehensive Context Generation**: Generate rich, contextually relevant answers by seamlessly combining information retrieved from GitHub with the reasoning capabilities of advanced language models. Llama-github excels at handling even the most complex and lengthy questions, providing comprehensive and insightful responses that include extensive context to support your development needs.
 
-- **🚀 Asynchronous Processing Excellence**: Llama-github is built from the ground up to leverage the full potential of asynchronous programming. With meticulously implemented asynchronous mechanisms woven throughout the codebase, llama-github can handle multiple requests concurrently, significantly boosting overall performance. Experience the difference as llama-github efficiently manages high-volume workloads without compromising on speed or quality.
+- **🚀 Asynchronous Processing Excellence**: Llama-github is built from the ground up to leverage the full potential of asynchronous programming. With meticulously implemented asynchronous mechanisms woven throughout the codebase, llama-github can handle multiple requests concurrently, significantly boosting overall performance.
 
-- **🔧 Flexible LLM Integration**: Easily integrate llama-github with various LLM providers, embedding models, and reranking models to tailor the library's capabilities to your specific requirements. Our extensible architecture allows you to customize and enhance llama-github's functionality, ensuring that it adapts seamlessly to your unique development environment.
+- **🔧 Flexible LLM Integration**: Easily integrate llama-github with various LLM providers, embedding models, reranking models, or an injected LangChain-compatible chat model to tailor the library's capabilities to your specific requirements.
 
 - **🔒 Robust Authentication Options**: Llama-github supports both personal access tokens and GitHub App authentication, providing you with the flexibility to integrate it into different development setups. Whether you're an individual developer or working within an organizational context, llama-github has you covered with secure and reliable authentication mechanisms.
 
@@ -120,7 +124,7 @@ Our vision is to become a pivotal module in the future of AI-driven development
 
 ### Roadmap
 
-For a detailed view of our project roadmap, please visit our [Project Roadmap](https://github.com/users/JetXu-LLM/projects/2).
+For a historical view of the earlier roadmap, please visit [Vision and Roadmap](VISION_AND_ROADMAP.md).
 
 ## Acknowledgments
 

{llama_github-0.3.3 → llama_github-0.4.0}/llama_github/config/config.json

@@ -5,6 +5,10 @@
     "issue_search_criteria_prompt": "**Instructions:**\n- **Question-Driven GitHub Issue Search Criteria Generation:** Generate GitHub issue search criteria strings based on the provided question. Analyze the question to identify key concepts, technologies, and problem-solving approaches that can help locate relevant issues on GitHub. Consider using relevant `label:` or `is:` qualifiers when applicable.\n\n**Output Format:** Present each search criteria string on a new line, formatted for immediate use in GitHub's issue search, without additional explanations or commentary.\n\n**Optimization Considerations:**\n- **Keyword Relevance:** Extract keywords and phrases tightly related to the question that are likely to appear in issue titles, descriptions, and discussions. Prioritize terms that reflect specific problems, error messages, or technologies. Avoid generic terms like \"help\" or \"problem\" that may not effectively narrow down the search results.\n- **Contextual Understanding:** Use the question's draft answer to inform your keyword selection. Identify key aspects, technologies, or potential troubleshooting areas tightly related to the question but not only specific aspects of answers that can help refine the search criteria.\n- **Simplicity and Effectiveness:** Craft search criteria with simple and limited keywords which could lead to precise search results relevant to the original question. Strike a balance between specificity and breadth to ensure the criteria capture the essential aspects of the question without being overly restrictive.\n- **Multiple Perspectives:** Generate multiple search criteria strings that approach the question from different angles or emphasize different aspects mentioned in the question. This increases the chances of finding relevant issues that discuss similar problems or solutions.\n- **Leveraging Labels:** When appropriate, include relevant `label:` qualifiers in the search criteria to narrow down the results to issues with specific labels, such as \"bug,\" \"enhancement,\" or \"documentation.\" This can help focus the search on issues that align with the nature of the question.\n- **Considering Issue Discussions:** Keep in mind that issue discussions often contain valuable information, experiences, and workarounds shared by other developers. Craft search criteria that not only match the issue title and description but also consider the likelihood of the keywords appearing in the issue's comments and discussions.",
     "repo_search_criteria_prompt": "**Instructions:**\n- **Expertise-Driven Github Repository Search Criteria Generation:** Generate GitHub repo search criteria strings based on the provided question. Analyze the question leverage your expertise for related key concepts, technologies, and problem-solving approaches that can help locate relevant repositories on GitHub. Focus on practical keywords and phrases likely to be present in repository names, descriptions, and topics. Use the `language:` qualifier to direct your search toward repositories written in a specific language, keeping the criteria simple and effective.\n- **Necessity Score Determination:** Evaluate the necessity of conducting a GitHub repository search based on the difficulty of question. Determine if repository-level information is essential to comprehensively address the question. Assign a necessity score indicating the importance of performing a repository search.\n\n**Output Format:**\n- **Necessity Score:** Begin your output with a necessity score (0-100) indicating the importance of performing a separate GitHub repository search. Use the following scale:\n  - 0-59: Low necessity - Only code and issue search results is sufficient.\n  - 60-79: Medium necessity - One repository search may offer additional insights and context.\n  - 80-100: High necessity - Two repository searches are crucial to gather comprehensive information, such as project structure, documentation, or community engagement, to thoroughly address the question.\n\n- **Search Criteria:** Present each search criteria string on a new line, formatted for immediate use in GitHub's repository search, without additional explanations or commentary.\n**Optimization Considerations:**\n- **Keyword Relevance:** Generate search criteria keywords and phrases from the question that are uniquely relevant to repository names, descriptions, and topics. Prioritize terms that reflect the broader context, expertise, and strategic thinking required to address the question effectively. Avoid generic terms that may lead to irrelevant search results.\n- **Simplicity and Effectiveness:** Craft search criteria that are simple yet effective in narrowing down the repository search results to the most relevant and informative ones. Strike a balance between specificity and breadth, ensuring that the criteria capture the essential aspects of the question without being overly restrictive. Aim for criteria that yield a manageable number of high-quality repository results.\n- **Language and Platform Specificity:** If the question pertains to a specific programming language or platform, incorporate relevant language or platform-specific keywords in the search criteria. Use the `language:` qualifier to filter repositories based on the language of interest. This helps focus the search on repositories that are more likely to contain relevant code, documentation, and community expertise.\n- **Multiple Criteria Flexibility:** Generate multiple search criteria strings that approach the question from different angles or emphasize different aspects mentioned in the question. This flexibility allows for a more comprehensive repository search, increasing the chances of discovering relevant repositories that may offer valuable insights, code samples, or best practices related to the question at hand.",
     "scoring_context_prompt": "You are an expert in evaluating the relevance of coding-related contexts to given questions. Your primary function is to analyze the provided context and question, and output a single integer score between 0 and 100, indicating how well the context supports answering the question.\n\nScoring criteria:\n0-20: The context is completely irrelevant to the question and provides no useful information to answer it.\n21-40: The context is slightly relevant to the question but lacks crucial information to provide a complete answer.\n41-60: The context is somewhat relevant to the question and provides some useful information, but it may not be sufficient to fully answer the question.\n61-80: The context is highly relevant to the question and provides most of the necessary information to answer it, but some minor details may be missing.\n81-100: The context is extremely relevant to the question and provides all the necessary information to comprehensively answer it.\n\nRemember, your output should consist of only a single integer score without any additional text or explanation. Analyze the context and question carefully, and provide a score that accurately reflects the relevance of the context in answering the question.",
+    "default_openai_model": "gpt-4o-mini",
+    "default_openai_simple_model": "gpt-4o-mini",
+    "default_mistral_model": "mistral-small-latest",
+    "default_mistral_simple_model": "mistral-small-latest",
     "default_embedding": "jinaai/jina-embeddings-v2-base-code",
     "default_reranker": "jinaai/jina-reranker-v2-base-multilingual",
     "min_stars_to_keep_result": 20,
@@ -17,4 +21,4 @@
     "repo_chunk_size": 7000,
     "google_chunk_size": 7000,
     "top_n_contexts": 4
-}
+}

{llama_github-0.3.3 → llama_github-0.4.0}/llama_github/config/config.py

@@ -1,11 +1,9 @@
-# config.py
 import json
-from importlib import resources
-from llama_github.logger import logger
+from importlib.resources import files
 
-# utils.py
 class SingletonMeta(type):
     _instances = {}
+
     def __call__(cls, *args, **kwargs):
         if cls not in cls._instances:
             instance = super().__call__(*args, **kwargs)
@@ -17,14 +15,13 @@ class Config(metaclass=SingletonMeta):
 
     def __init__(self):
         if Config._config is None:
-            with resources.open_text('llama_github.config', 'config.json') as file:
-                Config._config = json.load(file)
+            config_path = files("llama_github.config").joinpath("config.json")
+            Config._config = json.loads(config_path.read_text(encoding="utf-8"))
 
     @classmethod
     def get(cls, key, default=None):
-        # Ensure the singleton instance is created
         if cls._config is None:
             cls()
         return cls._config.get(key, default)
 
-config = Config()
+config = Config()