deepl-haystack 0.1.0__tar.gz

deepl_haystack-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2024 Dribia Data Research S.L. (https://www.dribia.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.

deepl_haystack-0.1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: deepl-haystack
+Version: 0.1.0
+Summary: Haystack integration with DeepL translation services provider.
+Home-page: https://github.com/dribia/deepl-haystack
+License: Apache-2.0
+Keywords: haystack,deepl,translation,nlp
+Author: Albert Iribarne
+Author-email: iribarne@dribia.com
+Maintainer: Albert Iribarne
+Maintainer-email: iribarne@dribia.com
+Requires-Python: >=3.9,<3.13
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Dist: deepl (>=1.18.0,<2.0.0)
+Requires-Dist: haystack-ai (>=2.3.0,<3.0.0)
+Project-URL: Bug Tracker, https://github.com/dribia/deepl-haystack/issues
+Project-URL: Repository, https://github.com/dribia/deepl-haystack
+Description-Content-Type: text/markdown
+
+DeepL Haystack Integration
+==========================
+
+|         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| CI/CD   | [![Tests](https://github.com/dribia/deepl-haystack/actions/workflows/test.yml/badge.svg)](https://github.com/dribia/deepl-haystack/actions/workflows/test.yml) [![Coverage Status](https://img.shields.io/codecov/c/github/dribia/driconfig)](https://codecov.io/gh/dribia/driconfig) [![Tests](https://github.com/dribia/deepl-haystack/actions/workflows/lint.yml/badge.svg)](https://github.com/dribia/deepl-haystack/actions/workflows/lint.yml) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) |
+| Package | [![PyPI](https://img.shields.io/pypi/v/deepl-haystack)](https://pypi.org/project/deepl-haystack/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/deepl-haystack?color=blue&logo=pypi&logoColor=gold) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/deepl-haystack?logo=python&logoColor=gold) [![GitHub](https://img.shields.io/github/license/dribia/deepl-haystack?color=blue)](LICENSE)                                                                                                                                                                                |
+---
+
+**Table of Contents**
+
+- [deepl-haystack](#deepl-haystack-integration)
+  - [Installation](#installation)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+## Installation
+
+```console
+pip install deepl-haystack
+```
+
+## Contributing
+
+[Poetry](https://python-poetry.org) is the best way to interact with this project, to install it,
+follow the official [Poetry installation guide](https://python-poetry.org/docs/#installation).
+
+With `poetry` installed, one can install the project dependencies with:
+
+```shell
+poetry install
+```
+
+Then, to run the tests:
+
+```shell
+make test
+```
+
+To run the linters `ruff` and `mypy`:
+
+```shell
+make lint
+```
+
+To apply all code formatting:
+
+```shell
+make format
+```
+
+## License
+
+`google-vertex-haystack` is distributed under the terms of the
+[MIT](https://opensource.org/license/mit) license.
+

deepl_haystack-0.1.0/README.md

@@ -0,0 +1,55 @@
+DeepL Haystack Integration
+==========================
+
+|         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| CI/CD   | [![Tests](https://github.com/dribia/deepl-haystack/actions/workflows/test.yml/badge.svg)](https://github.com/dribia/deepl-haystack/actions/workflows/test.yml) [![Coverage Status](https://img.shields.io/codecov/c/github/dribia/driconfig)](https://codecov.io/gh/dribia/driconfig) [![Tests](https://github.com/dribia/deepl-haystack/actions/workflows/lint.yml/badge.svg)](https://github.com/dribia/deepl-haystack/actions/workflows/lint.yml) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) |
+| Package | [![PyPI](https://img.shields.io/pypi/v/deepl-haystack)](https://pypi.org/project/deepl-haystack/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/deepl-haystack?color=blue&logo=pypi&logoColor=gold) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/deepl-haystack?logo=python&logoColor=gold) [![GitHub](https://img.shields.io/github/license/dribia/deepl-haystack?color=blue)](LICENSE)                                                                                                                                                                                |
+---
+
+**Table of Contents**
+
+- [deepl-haystack](#deepl-haystack-integration)
+  - [Installation](#installation)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+## Installation
+
+```console
+pip install deepl-haystack
+```
+
+## Contributing
+
+[Poetry](https://python-poetry.org) is the best way to interact with this project, to install it,
+follow the official [Poetry installation guide](https://python-poetry.org/docs/#installation).
+
+With `poetry` installed, one can install the project dependencies with:
+
+```shell
+poetry install
+```
+
+Then, to run the tests:
+
+```shell
+make test
+```
+
+To run the linters `ruff` and `mypy`:
+
+```shell
+make lint
+```
+
+To apply all code formatting:
+
+```shell
+make format
+```
+
+## License
+
+`google-vertex-haystack` is distributed under the terms of the
+[MIT](https://opensource.org/license/mit) license.

deepl_haystack-0.1.0/deepl_haystack/__init__.py

@@ -0,0 +1,10 @@
+"""DeepL Haystack integration."""
+
+from .components.translators.deepl.translator import (
+    DeepLDocumentTranslator,
+    DeepLTextTranslator,
+)
+
+__version__ = "0.1.0"
+
+__all__ = ["DeepLDocumentTranslator", "DeepLTextTranslator"]

deepl_haystack-0.1.0/deepl_haystack/components/translators/deepl/translator.py

@@ -0,0 +1,203 @@
+"""DeepL translator component."""
+
+from typing import Any, Dict, List, Optional, Union
+
+from deepl import Formality, TextResult, Translator
+from haystack import Document, component, default_from_dict, default_to_dict
+from haystack.utils import Secret, deserialize_secrets_inplace
+
+
+@component
+class DeepLTextTranslator:
+    """Enables translation of text using DeepL API."""
+
+    def __init__(
+        self,
+        api_key: Secret = Secret.from_env_var("DEEPL_API_KEY"),  # noqa: B008
+        source_lang: Optional[str] = None,
+        target_lang: str = "EN-US",
+        formality: Union[str, Formality, None] = None,
+    ):
+        """Create a DeepLTextTranslator component.
+
+        Args:
+            api_key: DeepL API Authentication Key.
+            source_lang: Language code of the input text, e.g. "DE"
+                for German, or "ES" for Spanish.
+            target_lang: Language code to translate the text into,
+                defaults to "EN", for English.
+            formality: Desired formality for translation, as
+            Formality enum, "less", "more", "prefer_less",
+            "prefer_more", or "default".
+
+        """
+        self.api_key: Secret = api_key
+        self.client: Translator = Translator(auth_key=self.api_key.resolve_value())
+        self.source_lang: Optional[str] = source_lang
+        self.target_lang: str = target_lang
+        self.formality: Formality = Formality(formality or Formality.DEFAULT)
+
+    @component.output_types(translation=str, meta=Dict[str, Any])
+    def run(self, text: str, source_lang: Optional[str] = None):
+        """Translate a single string.
+
+        Args:
+            text: Text to translate.
+            source_lang: Language code of the input text, e.g. "DE"
+                for German, or "ES" for Spanish. If informed, takes
+                precedence over the `source_lang` informed at
+                initialization.
+
+        Returns: A dictionary with the following keys:
+            - `translation`: The translation of the input text.
+            - `meta`: Information about the usage of the model.
+
+        """
+        if not isinstance(text, str):
+            raise TypeError(
+                "DeepLTextTranslator expects a string as an input. "
+                "In case you want to translate a list of Documents, "
+                "please use the DeepLDocumentTranslator."
+            )
+
+        translation = self.client.translate_text(
+            text,
+            source_lang=source_lang or self.source_lang or None,
+            target_lang=self.target_lang,
+            formality=self.formality,
+        )
+        assert isinstance(translation, TextResult)
+        meta = {
+            "source_lang": translation.detected_source_lang,
+            "target_lang": self.target_lang,
+        }
+        return {"translation": translation.text, "meta": meta}
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Serializes the component to a dictionary.
+
+        Returns: Dictionary with serialized data.
+
+        """
+        return default_to_dict(
+            self,
+            api_key=self.api_key.to_dict(),
+            source_lang=self.source_lang,
+            target_lang=self.target_lang,
+            formality=self.formality.value,
+        )
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "DeepLTextTranslator":
+        """Deserializes the component from a dictionary.
+
+        Args:
+            data: Dictionary to deserialize from.
+
+        Returns: Deserialized component.
+
+        """
+        deserialize_secrets_inplace(data["init_parameters"], keys=["api_key"])
+        return default_from_dict(cls, data)
+
+
+@component
+class DeepLDocumentTranslator:
+    """Enables translation of Haystack Documents using DeepL API."""
+
+    def __init__(
+        self,
+        api_key: Secret = Secret.from_env_var("DEEPL_API_KEY"),  # noqa: B008
+        source_lang: Optional[str] = None,
+        target_lang: str = "EN-US",
+        formality: Union[str, Formality, None] = None,
+    ):
+        """Create a DeepLDocumentTranslator component.
+
+        Args:
+            api_key: DeepL API Authentication Key.
+            source_lang: Language code of the input text, e.g. "DE"
+                for German, or "ES" for Spanish.
+            target_lang: Language code to translate the text into,
+                defaults to "EN", for English.
+            formality: Desired formality for translation, as
+            Formality enum, "less", "more", "prefer_less",
+            "prefer_more", or "default".
+
+        """
+        self.api_key: Secret = api_key
+        self.client: Translator = Translator(auth_key=self.api_key.resolve_value())
+        self.source_lang: Optional[str] = source_lang
+        self.target_lang: str = target_lang
+        self.formality: Formality = Formality(formality or Formality.DEFAULT)
+
+    @component.output_types(documents=List[Document])
+    def run(self, documents: List[Document], source_lang: Optional[str] = None):
+        """Translate a list of Haystack Documents.
+
+        Args:
+            documents: Documents to translate.
+            source_lang: Language code of the input documents text,
+                e.g. "DE" for German, or "ES" for Spanish. If informed,
+                takes precedence over the `source_lang` informed at
+                initialization.
+
+        Returns: A list of documents with the translated text.
+            Original document metadata is preserved.
+
+        """
+        if not (
+            isinstance(documents, list)
+            and all(isinstance(doc, Document) for doc in documents)
+        ):
+            raise TypeError(
+                "DeepLTextTranslator expects a list of Haystack documents as input."
+            )
+
+        translations = self.client.translate_text(
+            [doc.content for doc in documents],
+            source_lang=source_lang or self.source_lang or None,
+            target_lang=self.target_lang,
+            formality=self.formality,
+        )
+        assert isinstance(translations, list)
+        for _translation in translations:
+            pass
+        return [
+            Document(
+                content=translation.text,
+                meta=dict(
+                    **document.meta,
+                    source_lang=translation.detected_source_lang,
+                    target_lang=self.target_lang,
+                ),
+            )
+            for document, translation in zip(documents, translations)
+        ]
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Serializes the component to a dictionary.
+
+        Returns: Dictionary with serialized data.
+
+        """
+        return default_to_dict(
+            self,
+            api_key=self.api_key.to_dict(),
+            source_lang=self.source_lang,
+            target_lang=self.target_lang,
+            formality=self.formality.value,
+        )
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "DeepLTextTranslator":
+        """Deserializes the component from a dictionary.
+
+        Args:
+            data: Dictionary to deserialize from.
+
+        Returns: Deserialized component.
+
+        """
+        deserialize_secrets_inplace(data["init_parameters"], keys=["api_key"])
+        return default_from_dict(cls, data)

deepl_haystack-0.1.0/pyproject.toml

@@ -0,0 +1,107 @@
+[tool.poetry]
+name = "deepl-haystack"
+version = "0.1.0"
+description = "Haystack integration with DeepL translation services provider."
+authors = ["Albert Iribarne <iribarne@dribia.com>"]
+maintainers = ["Albert Iribarne <iribarne@dribia.com>", "Dribia Data Research <code@dribia.com>"]
+license = "Apache-2.0"
+readme = "README.md"
+repository = "https://github.com/dribia/deepl-haystack"
+homepage = "https://github.com/dribia/deepl-haystack"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+keywords = ["haystack", "deepl", "translation", "nlp"]
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/dribia/deepl-haystack/issues"
+
+[tool.poetry.dependencies]
+python = ">=3.9,<3.13"
+deepl = "^1.18.0"
+haystack-ai = "^2.3.0"
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.3.1"
+pytest-mock = "^3.14.0"
+pytest-cov = "^5.0.0"
+
+[tool.poetry.group.lint.dependencies]
+ruff = "0.5.5"
+mypy = "1.11.0"
+
+[tool.poetry.group.dev.dependencies]
+pre-commit = "^3.7.1"
+
+[tool.ruff]
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+    "D",  # pydocstyle
+    "UP",  # pyupgrade
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "C901",  # function is too complex
+    "D206",  # indent with spaces, not recommended with formatter
+    "W191",  # tab-indentation, not recommended with formatter
+    "D203",  # no-blank-line-before-class
+    "D213",  # multi-line-summary-second-line
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D"]
+
+[tool.ruff.lint.isort]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.mypy]
+plugins = []
+strict_optional = true
+ignore_missing_imports = false
+
+[[tool.mypy.overrides]]
+module = [
+    "haystack",
+    "haystack.utils"
+]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+minversion = "8.0"
+addopts = "--verbose"
+filterwarnings = 'error'
+xfail_strict = true
+testpaths = ["tests"]
+markers = []
+
+[tool.coverage.run]
+source = ["deepl_haystack", "tests"]
+branch = true
+
+[tool.coverage.report]
+precision = 2
+exclude_lines = [
+    'pragma: no cover',
+    'raise NotImplementedError',
+    'if TYPE_CHECKING:',
+    '@overload',
+]
+
+[tool.coverage.xml]
+output = "coverage.xml"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"