Relnote-extractor parses raw update texts, extracting version, date, features, fixes, and formats into a clean, concise summary.
Project description
Relnote Extractor
Extract and structure release notes from software update announcements
Overview
This package is designed to extract and structure release notes from software update announcements. It takes raw text containing software release information as input and processes it to identify and format key details such as version numbers, release dates, new features, bug fixes, and other relevant updates.
Features
- Extracts and structures release notes from software update announcements
- Supports multiple language models via
langchainlibrary - Can use default
ChatLLM7fromlangchain_llm7library or user-provided LLM instance - Allows users to pass their own API key for higher rate limits (LLM7 free tier sufficient for most use cases)
- Easy to use and integrate into existing workflows
Installation
pip install relnote_extractor
Example Usage
from relnote_extractor import relnote_extractor
user_input = """
Release Notes:
* Fixed issue with XYZ
* Added feature ABC
* Updated to version 1.2.3
"""
response = relnote_extractor(user_input)
print(response)
Input Parameters
user_input: str - the user input text to processllm: Optional[BaseChatModel] - the langchain LLM instance to use (default:ChatLLM7fromlangchain_llm7)api_key: Optional[str] - the API key for LLM7 (default:None)
Using a Different LLM
You can safely pass your own LLM instance based on https://docs.langchain.com/llm.html if you want to use another LLM. For example, to use the OpenAI LLM:
from langchain_openai import ChatOpenAI
from relnote_extractor import relnote_extractor
llm = ChatOpenAI()
response = relnote_extractor(user_input, llm=llm)
Similarly, you can use the Anthropic or Google Generative AI LLMs:
from langchain_anthropic import ChatAnthropic
from relnote_extractor import relnote_extractor
llm = ChatAnthropic()
response = relnote_extractor(user_input, llm=llm)
from langchain_google_genai import ChatGoogleGenerativeAI
from relnote_extractor import relnote_extractor
llm = ChatGoogleGenerativeAI()
response = relnote_extractor(user_input, llm=llm)
Rate Limits
The default rate limits for LLM7 free tier are sufficient for most use cases of this package. If you need higher rate limits, you can pass your own api_key via environment variable LLM7_API_KEY or via passing it directly like relnote_extractor(user_input, api_key="your_api_key"). You can get a free API key by registering at https://token.llm7.io/
GitHub Issues
https://github.com/chigwell/relnote-extractor/issues
Author
Eugene Evstafev (hi@eugene.plus)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file relnote_extractor-2025.12.22080754.tar.gz.
File metadata
- Download URL: relnote_extractor-2025.12.22080754.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
626899fe01c585d862bd16dfc3cd32d55591336565c7b2af98f2fa6ed0182b48
|
|
| MD5 |
b0091a8d7cb42622cdeeb44b6b8030d6
|
|
| BLAKE2b-256 |
c841826322b14cb850acc7ff8fe6fae51956d16dbc3c58dc611eda992702e575
|
File details
Details for the file relnote_extractor-2025.12.22080754-py3-none-any.whl.
File metadata
- Download URL: relnote_extractor-2025.12.22080754-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
af4fb7ac3ae44f1f3ca160dc58d303b9100b5a382f9c672e1987532550f6004b
|
|
| MD5 |
b31ab388354103b912ec534f3ae8a3ab
|
|
| BLAKE2b-256 |
b6c73e10489145abe99e99bf6588e9dcc65eac4f8431aceab090c04962f772e9
|