Rename library, add changelog

Author: pamelafox

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.4] - April 21, 2024
+
+- Rename to openai-messages-token-helper from llm-messages-token-helper to reflect library's current OpenAI focus.
+
+## [0.0.3] - April 21, 2024
+
+- Fix for `count_tokens_for_message` function to match OpenAI output precisely, particularly for calls with images to GPT-4  vision.

README.md

@@ -1,4 +1,4 @@
-# llm-messages-token-helper
+# openai-messages-token-helper
 
 A helper library for estimating tokens used by messages and building messages lists that fit within the token limits of a model.
 Currently designed to work with the OpenAI GPT models (including GPT-4 turbo with vision).
@@ -9,7 +9,7 @@ Uses the tiktoken library for tokenizing text and the Pillow library for image-r
 Install the package:
 
 ```sh
-python3 -m pip install llm-messages-token-helper
+python3 -m pip install openai-messages-token-helper
 ```
 
 ## Usage
@@ -43,7 +43,7 @@ Returns:
 Example:
 
 ```python
-from llm_messages_token_helper import build_messages
+from openai_messages_token_helper import build_messages
 
 messages = build_messages(
     model="gpt-35-turbo",
@@ -87,7 +87,7 @@ Returns:
 Example:
 
 ```python
-from llm_messages_token_helper import count_tokens_for_message
+from openai_messages_token_helper import count_tokens_for_message
 
 message = {
     "role": "user",
@@ -116,7 +116,7 @@ Example:
 Count the number of tokens for an image sent to GPT-4-vision:
 
 ```python
-from llm_messages_token_helper import count_tokens_for_image
+from openai_messages_token_helper import count_tokens_for_image
 
 image = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEA..."
 num_tokens = count_tokens_for_image(image)
@@ -137,7 +137,7 @@ Returns:
 Example:
 
 ```python
-from llm_messages_token_helper import get_token_limit
+from openai_messages_token_helper import get_token_limit
 
 model = "gpt-4"
 max_tokens = get_token_limit(model)

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
-name = "llm-messages-token-helper"
-description = "A helper library for estimating tokens used by messages."
-version = "0.0.3"
+name = "openai-messages-token-helper"
+description = "A helper library for estimating tokens used by messages sent through OpenAI Chat Completions API."
+version = "0.0.4"
 authors = [{name = "Pamela Fox"}]
 requires-python = ">=3.9"
 readme = "README.md"
@@ -15,15 +15,14 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Framework :: Pytest"
     ]
 
 [project.urls]
-Home = "https://github.com/pamelafox/llm-messages-token-helper"
+Home = "https://github.com/pamelafox/openai-messages-token-helper"
 
 [project.optional-dependencies]
 dev = [

src/llm_messages_token_helper/__init__.py renamed to src/openai_messages_token_helper/__init__.py

@@ -1,7 +1,7 @@
 import base64
 
 import pytest
-from llm_messages_token_helper import count_tokens_for_image
+from openai_messages_token_helper import count_tokens_for_image
 
 
 @pytest.fixture

src/llm_messages_token_helper/images_helper.py renamed to src/openai_messages_token_helper/images_helper.py

@@ -1,4 +1,4 @@
-from llm_messages_token_helper import build_messages, count_tokens_for_message
+from openai_messages_token_helper import build_messages, count_tokens_for_message
 
 from .messages import system_message_short, system_message_unicode, user_message, user_message_unicode
 

src/llm_messages_token_helper/message_builder.py renamed to src/openai_messages_token_helper/message_builder.py

@@ -1,5 +1,5 @@
 import pytest
-from llm_messages_token_helper import count_tokens_for_message, get_token_limit
+from openai_messages_token_helper import count_tokens_for_message, get_token_limit
 
 from .messages import system_message, system_message_with_name, text_and_image_message, user_message