kr-translator 0.1.0__tar.gz

kr_translator-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [the.zlood@gmail.com]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kr_translator-0.1.0/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.1
+Name: kr-translator
+Version: 0.1.0
+Summary: 
+License: MIT
+Author: zlood
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: langchain (>=0.2.6,<0.3.0)
+Requires-Dist: langchain-community (>=0.2.6,<0.3.0)
+Requires-Dist: langchain-openai (>=0.1.13,<0.2.0)
+Description-Content-Type: text/markdown
+
+# KR Translator
+
+Translate a korean `txt` file.
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install kr-translation
+```
+
+## Usage
+
+### Getting OPENAI API KEY
+
+1. Go to [https://platform.openai.com/api-keys](https://platform.openai.com/api-keys), follow instruction over there.
+
+2. Save the API KEY somewhere save.
+
+### Basic Translation
+
+```python
+from kr_translator.caller import TextTranslator
+
+translator = TextTranslator(
+  api_key="your_api_key_here", 
+  source_file_location="/path/to/file.txt"
+)
+output = translator.translate()
+
+print(output)
+```
+
+### Save Translation to a file
+
+```python
+from kr_translator.caller import TextTranslator
+
+translator = TextTranslator(
+  api_key="your_api_key_here", 
+  source_file_location="/path/to/file.txt"
+)
+output = translator.translate()
+translator.save_translation("output_file.txt")
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE.md file for details.
+

kr_translator-0.1.0/README.md

@@ -0,0 +1,50 @@
+# KR Translator
+
+Translate a korean `txt` file.
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install kr-translation
+```
+
+## Usage
+
+### Getting OPENAI API KEY
+
+1. Go to [https://platform.openai.com/api-keys](https://platform.openai.com/api-keys), follow instruction over there.
+
+2. Save the API KEY somewhere save.
+
+### Basic Translation
+
+```python
+from kr_translator.caller import TextTranslator
+
+translator = TextTranslator(
+  api_key="your_api_key_here", 
+  source_file_location="/path/to/file.txt"
+)
+output = translator.translate()
+
+print(output)
+```
+
+### Save Translation to a file
+
+```python
+from kr_translator.caller import TextTranslator
+
+translator = TextTranslator(
+  api_key="your_api_key_here", 
+  source_file_location="/path/to/file.txt"
+)
+output = translator.translate()
+translator.save_translation("output_file.txt")
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE.md file for details.

kr_translator-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[tool.poetry]
+name = "kr-translator"
+version = "0.1.0"
+description = ""
+authors = ["zlood"]
+license = "MIT"
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+langchain = "^0.2.6"
+langchain-community = "^0.2.6"
+langchain-openai = "^0.1.13"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.2.2"
+pytest-asyncio = "^0.23.7"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+minversion = 6.0
+addopts = "-ra -q -m 'not call_openai'"
+testpaths = ["tests"]
+asyncio_mode = "auto"
+markers = """
+    call_openai: mark tests that call OpenAI APIs
+"""

kr_translator-0.1.0/src/kr_translator/caller.py

@@ -0,0 +1,111 @@
+from langchain_community.callbacks import get_openai_callback
+from langchain_community.document_loaders.text import TextLoader
+from langchain_core.prompts import ChatPromptTemplate
+from langchain_openai.chat_models import ChatOpenAI
+from langchain_core.output_parsers.string import StrOutputParser
+
+from kr_translator.exceptions import TextLoaderError
+
+
+def _get_prompt(additional="", characters=""):
+    baseline_instructions = """
+        # instruction
+        You are Korean text translator. Your job is to translate the korean text to english.
+        Keep the korean honorific that is commonly used, such as oppa, noona, hyung, and unnie as it is.
+        Translate all sound effects.
+    """
+
+    named_entities = """
+        # named entities
+        do not translate named entities such as people's name or company name.
+    """
+
+    additional_instruction = """
+        # additional instruction
+    """
+    return (
+        baseline_instructions
+        + named_entities
+        + characters
+        + additional_instruction
+        + additional
+    )
+
+
+class TextTranslator:
+    """
+    A class used to translate text from a source file using the OpenAI API.
+
+    Attributes:
+        api_key (str): The API key for accessing OpenAI services.
+        source_file_location (str): The location of the source text file to be translated.
+
+    Methods:
+        translate(characters="", additional_info=""): Translates the text from the source file using the specified characters and additional information.
+        save_translation(destination_file_location="file.txt"): Saves the translated text to the specified destination file location.
+    """
+
+    def __init__(self, api_key, source_file_location):
+        if not source_file_location.endswith(".txt"):
+            raise ValueError("The source file must be a .txt file")
+        self.llm = ChatOpenAI(
+            openai_api_key=api_key,
+            model="gpt-4o",
+        )
+        self.source_file_location = source_file_location
+
+    def translate(self, characters="", additional_info=""):
+        """
+        Translates the text from the source file using the specified characters and additional information.
+
+        Args:
+            characters (str, optional): Specific characters or personalities to use in the translation. Defaults to "".
+            additional_info (str, optional): Additional information or context to provide to the translation model. Defaults to "".
+
+        Returns:
+            str: The translated text.
+
+        Raises:
+            TextLoaderError: If the source file cannot be loaded.
+        """
+        try:
+            loader = TextLoader(self.source_file_location)
+            document = loader.load()
+        except Exception as e:
+            raise TextLoaderError(
+                f"Failed to load the file {self.source_file_location}"
+            ) from e
+
+        prompt = ChatPromptTemplate.from_messages(
+            [
+                (
+                    "system",
+                    _get_prompt(additional=additional_info, characters=characters),
+                ),
+                ("human", "{input}"),
+            ]
+        )
+        parser = StrOutputParser()
+
+        chain = prompt | self.llm | parser
+
+        with get_openai_callback() as cb:
+            output = chain.invoke({"input": document})
+            print(f"Total Tokens: {cb.total_tokens}")
+            print(f"Prompt Tokens: {cb.prompt_tokens}")
+            print(f"Completion Tokens: {cb.completion_tokens}")
+            print(f"Total Cost (USD): ${cb.total_cost}")
+
+            return output
+
+    def save_translation(self, destination_file_location: str = "file.txt"):
+        """
+        Saves the translated text to the specified destination file location.
+
+        Args:
+            destination_file_location (str, optional): The location to save the translated text file. Defaults to "file.txt".
+        """
+        translated_text = self.translate()
+
+        with open(destination_file_location, "w") as file:
+            file.write(translated_text)

kr_translator-0.1.0/src/kr_translator/exceptions.py

@@ -0,0 +1,2 @@
+class TextLoaderError(Exception):
+    pass