Release Structurer

A Python package designed to process and structure text inputs related to software development and release notes. The package leverages llmatch-messages to ensure that the input text is parsed and formatted consistently.

Installation

pip install release-structurer

Usage

Basic Usage

from release_structurer import release_structurer

user_input = "GDB 17.1 Released with shadow and guard stack support"
response = release_structurer(user_input)
print(response)

Using a Custom LLM

By default, the package uses ChatLLM7 from langchain_llm7. However, you can pass your own LLM instance if you want to use another LLM.

Example with OpenAI

from langchain_openai import ChatOpenAI
from release_structurer import release_structurer

llm = ChatOpenAI()
response = release_structurer(user_input, llm=llm)
print(response)

Example with Anthropic

from langchain_anthropic import ChatAnthropic
from release_structurer import release_structurer

llm = ChatAnthropic()
response = release_structurer(user_input, llm=llm)
print(response)

Example with Google

from langchain_google_genai import ChatGoogleGenerativeAI
from release_structurer import release_structurer

llm = ChatGoogleGenerativeAI()
response = release_structurer(user_input, llm=llm)
print(response)

Using a Custom API Key

The default rate limits for LLM7 free tier are sufficient for most use cases of this package. If you want higher rate limits, you can pass your own API key via the api_key parameter or set the LLM7_API_KEY environment variable.

Example with API Key

from release_structurer import release_structurer

user_input = "GDB 17.1 Released with shadow and guard stack support"
response = release_structurer(user_input, api_key="your_api_key")
print(response)

You can get a free API key by registering at LLM7.

Parameters

• user_input (str): The user input text to process.
• llm (Optional[BaseChatModel]): The LangChain LLM instance to use. If not provided, the default ChatLLM7 will be used.
• api_key (Optional[str]): The API key for LLM7. If not provided, the package will use the LLM7_API_KEY environment variable or default to None.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

• Eugene Evstafev - chigwell - hi@eugene.plus

Issues

If you encounter any issues, please report them on the GitHub issues page.