fix: add missing information for the pyproject toml files and add dedicated documentaion for each lib #151
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…oject.toml with metadata and remove unused secret provider
…nsistency and clarity
…ons in existing READMEs for consistency
…api-lib; adjust fasttext dependency
…pi-lib, rag-core-api, and rag-core-lib; adjust dependencies and metadata
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates package versions and dependencies across the RAG template monorepo to version 3.2.0, adds comprehensive README documentation for all library packages, and removes an unused SecretProvider interface.
- Updated all library and service versions from
1.0.1tov3.2.0with improved descriptions - Added comprehensive README files for
rag-core-lib,rag-core-api,admin-api-lib, andextractor-api-lib - Updated dependencies including FastAPI (0.116.x → 0.118.3), langchain packages, langfuse (3.3.4 → 3.6.1), and others
- Replaced git-based
fasttextdependency with PyPI version 0.9.3 - Removed unused
SecretProviderinterface fromrag-core-lib - Added metadata fields (maintainers, license, repository, homepage) to library
pyproject.tomlfiles
Reviewed Changes
Copilot reviewed 12 out of 19 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| services/rag-backend/pyproject.toml | Updated name, version to 3.2.0, added description, removed trailing whitespace |
| services/rag-backend/poetry.lock | Updated dependencies: FastAPI, langchain, langfuse, requests, uvicorn, and local libs |
| services/document-extractor/pyproject.toml | Updated version to 3.2.0 and description |
| services/document-extractor/poetry.lock | Updated dependencies: FastAPI, fasttext (git→PyPI), langchain-core, unstructured, uvicorn, extractor-api-lib |
| services/admin-backend/pyproject.toml | Updated name, version to 3.2.0, and description |
| services/admin-backend/poetry.lock | Updated local library versions (admin-api-lib, rag-core-lib) |
| libs/rag-core-lib/pyproject.toml | Version bump, description update, added metadata (maintainers, license, repository, homepage, readme), changed pytest log_cli to boolean |
| libs/rag-core-lib/src/rag_core_lib/secret_provider/secret_provider.py | Removed unused SecretProvider interface file |
| libs/rag-core-lib/README.md | Added comprehensive library documentation |
| libs/rag-core-api/pyproject.toml | Version bump, description update, added metadata fields |
| libs/rag-core-api/poetry.lock | Updated rag-core-lib dependency version |
| libs/rag-core-api/README.md | Added comprehensive API layer documentation |
| libs/extractor-api-lib/pyproject.toml | Version bump, added metadata, changed fasttext from git to PyPI, changed pytest log_cli to boolean |
| libs/extractor-api-lib/poetry.lock | Updated fasttext (git→PyPI), updated content-hash |
| libs/extractor-api-lib/README.md | Added comprehensive extractor library documentation |
| libs/admin-api-lib/pyproject.toml | Version bump, description update, added metadata fields |
| libs/admin-api-lib/poetry.lock | Updated rag-core-lib dependency version |
| libs/admin-api-lib/README.md | Added comprehensive admin API documentation |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces major improvements to documentation, metadata, and configuration for the three main Python libraries in the STACKIT RAG template:
admin-api-lib,extractor-api-lib, andrag-core-api. The changes focus on adding comprehensive README files for each library, updating package metadata inpyproject.tomlfor clarity and compliance, and refining dependency and configuration management. These updates make the libraries easier to understand, install, and extend, and improve maintainability for both operators and developers.Documentation enhancements:
README.mdfiles forlibs/admin-api-lib,libs/extractor-api-lib, andlibs/rag-core-api, describing module responsibilities, features, endpoints, configuration, usage, extension, and contribution guidelines. [1] [2] [3]Package metadata and configuration improvements:
pyproject.tomlfor all three libraries to include new version numbers (v3.2.1), expanded author and maintainer information, license, repository, homepage, and readme fields for better package distribution and compliance. [1] [2] [3]libs/extractor-api-lib/pyproject.tomlby switchingfasttextto a stable PyPI version and adjusting other package versions.log_clito boolean and updating exclusions. [1] [2]These changes collectively strengthen the documentation, usability, and maintainability of the STACKIT RAG template libraries, making them more accessible for new users and contributors.