Merge pull request #73 from nidhaloff/nothead31/issue66

Minor version 1.5.0 Closes #66

AUTHORS.rst

@@ -12,3 +12,4 @@ Contributors
 
 @prataffel
 @senk8
+@nothead31

deep_translator/__init__.py

@@ -13,18 +13,17 @@
 from .papago import PapagoTranslator
 
 # TODO: Discussion: These should be declared in setup.cfg, setting them here is redundant
-# __author__ = """Nidhal Baccouri"""
-# __email__ = '[email protected]'
-# __version__ = '1.4.4'
+__author__ = """Nidhal Baccouri"""
+__email__ = '[email protected]'
+__version__ = '1.5.0'
 
-# __all__ = [GoogleTranslator,
-#            PonsTranslator,
-#            LingueeTranslator,
-#            MyMemoryTranslator,
-#            YandexTranslator,
-#            MicrosoftTranslator,
-#            QCRI,
-#            DeepL,
-#            main,
-#            single_detection,
-#            batch_detection]
+__all__ = [GoogleTranslator,
+           PonsTranslator,
+           LingueeTranslator,
+           MyMemoryTranslator,
+           YandexTranslator,
+           MicrosoftTranslator,
+           QCRI,
+           DeepL,
+           single_detection,
+           batch_detection]

deep_translator/detection.py

@@ -2,9 +2,10 @@
 language detection API
 """
 import requests
-from .configs import config # TODO: Discussion: Could this be moved here and remove configs.py entirely?
 from requests.exceptions import HTTPError
 
+# Module global config
+config = {"url": 'https://ws.detectlanguage.com/0.2/detect',"headers": {'User-Agent': 'Detect Language API Python Client 1.4.0','Authorization': 'Bearer {}',}}
 
 def get_request_body(text, api_key, *args, **kwargs):
     """

deep_translator/main.py

@@ -0,0 +1,124 @@
+"""Console script for deep_translator."""
+
+import click
+from .google_trans import GoogleTranslator
+from .mymemory import MyMemoryTranslator
+from .deepl import DeepL
+from .qcri import QCRI
+from .linguee import LingueeTranslator
+from .pons import PonsTranslator
+from .yandex import YandexTranslator
+from .microsoft import MicrosoftTranslator
+from .papago import PapagoTranslator
+
+CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+@click.group()
+def cli():
+    pass
+
+@cli.command(context_settings=CONTEXT_SETTINGS, no_args_is_help=True)
+@click.argument('translator', required=True, default='google', type=str)
+@click.option("--source", "-src", required=True, type=str, help="source language to translate from")
+@click.option("--target", "-tgt", required=True, type=str, help="target language to translate to")
+@click.option("--text", "-txt", type=str,required = True,prompt="Enter the text you want to translate",help="text you want to translate")
+@click.option("--api-key",type=str,help="required for DeepL, QCRI, Yandex, Microsoft and Papago translators")
+def translate(translator, source, target, text, api_key, languages):
+    """
+    Use TRANSLATOR to translate source material into another language.
+    \f
+    Directory function to send arguments to the correct translator.
+    @param translator: translator name parsed from terminal arguments
+    @return: None
+    """
+    api_key_required = ["deepl", "qcri", "yandex", "microsoft", "papago"]
+    if translator in api_key_required and not api_key:
+        click.echo(
+            "This translator requires an api key provided through --api-key")
+    else:
+        pass
+
+    if translator == "google":
+        translator = GoogleTranslator(source=source, target=target)
+    elif translator == "mymemory":
+        translator = MyMemoryTranslator(source=source, target=target)
+    elif translator == "deepl":
+        translator = DeepL(source=source, target=target, api_key=api_key)
+    elif translator == "qcri":
+        translator = QCRI(source=source, target=target, api_key=api_key)
+    elif translator == "linguee":
+        translator = LingueeTranslator(source=source, target=target)
+    elif translator == "pons":
+        translator = PonsTranslator(source=source, target=target)
+    elif translator == "yandex":
+        translator = YandexTranslator(
+            source=source,
+            target=target,
+            api_key=api_key)
+    elif translator == "microsoft":
+        translator = MicrosoftTranslator(
+            source=source,
+            target=target,
+            api_key=api_key)
+    elif translator == "papago":
+        translator = PapagoTranslator(
+            source=source,
+            target=target,
+            api_key=api_key)
+    else:
+        raise AttributeError("The given translator is not supported.")
+
+    res = translator.translate(text)
+    click.echo(f" | Translation from {source} to {target} |")
+    click.echo(f"Translated text: \n {res}")
+    return 0
+
+@cli.command(context_settings=CONTEXT_SETTINGS, no_args_is_help=True)
+@click.argument('translator')
+@click.argument('api_key', required=False)
+def languages(translator, api_key):
+    """
+    Retrieve the list of available languages from the given translator.
+    @param translator: Translator given by the user.
+    @param api_key: Optional API key given by the user. Required for some translators.
+    @return: None
+    """
+    translator = translator.lower()
+    api_key_required = ["deepl", "qcri", "yandex", "microsoft", "papago"]
+    if translator in api_key_required and not api_key:
+        click.echo("This translator requires an api key provided through --api-key")
+    else:
+        pass
+
+    if translator == "google":
+        translator = GoogleTranslator
+    elif translator == "mymemory":
+        translator = MyMemoryTranslator
+    elif translator == "qcri":
+        translator = QCRI(api_key=api_key)
+    elif translator == "linguee":
+        translator = LingueeTranslator
+    elif translator == "pons":
+        translator = PonsTranslator
+    elif translator == "yandex":
+        translator = YandexTranslator(api_key=api_key)
+    elif translator == "microsoft":
+        translator = MicrosoftTranslator(api_key=api_key)
+    elif translator == "papago":
+        translator = PapagoTranslator(api_key=api_key)
+    else:
+        raise AttributeError("The given translator is not supported.")
+
+    supported_languages = translator.get_supported_languages(as_dict=True)
+    click.echo(f"Languages supported by '{translator}' are :")
+    for k, v in supported_languages.items():
+        click.echo(f"|- {k}: {v}")
+    return 0
+
+@cli.command()
+def list():
+    """Lists available translators."""
+    click.echo("Available translators include: Google, MyMemory, QCRI, Linguee, Pons, Yandex, Microsoft (Bing), and Papago.")
+    return 0
+
+if __name__ == "__main__":
+    cli()

deep_translator/tests/test_cli.py

@@ -3,14 +3,20 @@
 """Tests for the CLI interface."""
 
 from click.testing import CliRunner
-from deep_translator import __main__
+from deep_translator import main
 
 def results_test():
     runner = CliRunner()
-    result = runner.invoke(__main__.main, [ 'google', 'auto', 'en', '좋은'])
+    result = runner.invoke(main.translate, [ 'google', 'auto', 'en', '좋은'])
     assert result.exit_code == 0
     assert result == 'good'
 
-    api_error = runner.invoke(__main__.main, ['microsoft','auto','en','Zwei minimale Dellchen auf der Rückseite.'])
+    api_error = runner.invoke(main.translate, ['microsoft','auto','en','Zwei minimale Dellchen auf der Rückseite.'])
     assert api_error.exit_code == 0
-    assert api_error == "This translator requires an api key provided through --api-key"
+    assert api_error == "This translator requires an api key provided through --api-key"
+
+    language_list_test = runner.invoke(main.languages, ['google'])
+    assert language_list_test.exit_code == 0
+
+    language_list_invalid_test = runner.invoke(main.languages, ['notValidTranslator'])
+    assert language_list_invalid_test.exception == AttributeError