minor refactoring and renamed cli.py to __main__ to reflect its true purpose

deep_translator/__init__.py

@@ -1,29 +1,28 @@
-"""Top-level package for deep_translator."""
+"""Top-level package for Deep Translator"""
 
-from deep_translator.google_trans import GoogleTranslator
-from deep_translator.pons import PonsTranslator
-from deep_translator.linguee import LingueeTranslator
-from deep_translator.mymemory import MyMemoryTranslator
-from deep_translator.yandex import YandexTranslator
-from deep_translator.qcri import QCRI
-from deep_translator.deepl import DeepL
-from deep_translator.detection import single_detection, batch_detection
-from deep_translator.microsoft import MicrosoftTranslator
-from deep_translator.cli import main
+from google_trans import GoogleTranslator
+from pons import PonsTranslator
+from linguee import LingueeTranslator
+from mymemory import MyMemoryTranslator
+from yandex import YandexTranslator
+from qcri import QCRI
+from deepl import DeepL
+from detection import single_detection, batch_detection
+from microsoft import MicrosoftTranslator
 
+# 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.4.4'
-
-__all__ = [GoogleTranslator,
-           PonsTranslator,
-           LingueeTranslator,
-           MyMemoryTranslator,
-           YandexTranslator,
-           MicrosoftTranslator,
-           QCRI,
-           DeepL,
-           main,
-           single_detection,
-           batch_detection]
+# __all__ = [GoogleTranslator,
+#            PonsTranslator,
+#            LingueeTranslator,
+#            MyMemoryTranslator,
+#            YandexTranslator,
+#            MicrosoftTranslator,
+#            QCRI,
+#            DeepL,
+#            main,
+#            single_detection,
+#            batch_detection]

deep_translator/{cli.py → __main__.py}

@@ -13,63 +13,31 @@ from papago import PapagoTranslator
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
-def main(translator, source, target, text, api_key, languages):
-    """
-    Use TRANSLATOR to translate source material into another language.\n
-    Available translators include: Google, MyMemory, QCRI, Linguee, Pons, Yandex, Microsoft (Bing), and Papago.\n
-    \n
-    \f
-    function responsible for parsing terminal arguments and provide them for
-    further use in the translation process
-    """
-    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"
-        )
-    elif languages:
-        print_supported_languages(translator, api_key)
-    else:
-        translate(translator, source, target, text, api_key)
-    # sys.exit()
-
-@click.command(context_settings=CONTEXT_SETTINGS)
-# @click.option(
-#     "--translator",
-#     "-trans",
-#     default="google",
-#     type=str,
-#     help="name of the translator you want to use",
-#     show_default=True,
-# )
-
+@click.command(name='Deep Translator', context_settings=CONTEXT_SETTINGS, no_args_is_help=True)
 @click.argument(
-    'translator',
-    required=True,
-    default='google',
-    type=str,
-)
-
+    'translator', 
+    required=True, 
+    default='google', 
+    type=str)
 @click.option(
-    "--source",
-    "-src",
-    required=True,
-    type=str,
-    help="source language to translate from"
-)
+    "--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"
-)
+    "--target", 
+    "-tgt", 
+    required=True, 
+    type=str, 
+    help="target language to translate to")
 @click.option(
-    "--text",
-    "-txt",
+    "--text", 
+    "-txt", 
     type=str,
-    help="text you want to translate"
-)
+    required = True,
+    prompt="Enter the text you want to translate",
+    help="text you want to translate")
 @click.option(
     "--api-key",
     type=str,
@@ -82,6 +50,23 @@ def main(translator, source, target, text, api_key, languages):
     help="list all the languages available with the translator."
     " Run with deep_translator <translator service> -lang",
 )
+def deep_translator(translator, source, target, text, api_key, languages):
+    """
+    Use TRANSLATOR to translate source material into another language.\n
+    Available translators include: Google, MyMemory, QCRI, Linguee, Pons, Yandex, Microsoft (Bing), and Papago.\n
+    \f
+    function responsible for parsing terminal arguments and provide them for
+    further use in the translation process
+    """
+    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"
+        )
+    elif languages:
+        print_supported_languages(translator, api_key)
+    else:
+        translate(translator, source, target, text, api_key)
 
 def translate(translator, source, target, text, api_key):
     """
@@ -171,4 +156,4 @@ def print_supported_languages(requested_translator, api_key):
         click.echo(f"|- {k}: {v}")
 
 if __name__ == "__main__":
-    main()
+    deep_translator()

deep_translator/deepl.py

@@ -1,9 +1,9 @@
 import requests
 from constants import BASE_URLS, DEEPL_LANGUAGE_TO_CODE
 from exceptions import (ServerException,
-                                        TranslationNotFound,
-                                        LanguageNotSupportedException,
-                                        AuthorizationException)
+                        TranslationNotFound,
+                        LanguageNotSupportedException,
+                        AuthorizationException)
 
 
 class DeepL(object):

deep_translator/linguee.py

@@ -4,11 +4,11 @@ linguee translator API
 
 from constants import BASE_URLS, LINGUEE_LANGUAGES_TO_CODES, LINGUEE_CODE_TO_LANGUAGE
 from exceptions import (LanguageNotSupportedException,
-                                        TranslationNotFound,
-                                        NotValidPayload,
-                                        ElementNotFoundInGetRequest,
-                                        RequestError,
-                                        TooManyRequests)
+                        TranslationNotFound,
+                        NotValidPayload,
+                        ElementNotFoundInGetRequest,
+                        RequestError,
+                        TooManyRequests)
 from parent import BaseTranslator
 from bs4 import BeautifulSoup
 import requests

deep_translator/mymemory.py

@@ -6,10 +6,10 @@ import warnings
 
 from constants import BASE_URLS, GOOGLE_LANGUAGES_TO_CODES
 from exceptions import (NotValidPayload,
-                                        TranslationNotFound,
-                                        LanguageNotSupportedException,
-                                        RequestError,
-                                        TooManyRequests)
+                        TranslationNotFound,
+                        LanguageNotSupportedException,
+                        RequestError,
+                        TooManyRequests)
 from parent import BaseTranslator
 import requests
 from time import sleep

deep_translator/parent.py

@@ -3,8 +3,6 @@
 from exceptions import NotValidPayload, NotValidLength, InvalidSourceOrTargetLanguage
 from abc import ABC, abstractmethod
 import string
-
-
 class BaseTranslator(ABC):
     """
     Abstract class that serve as a parent translator for other different translators

deep_translator/pons.py

@@ -5,11 +5,11 @@ from bs4 import BeautifulSoup
 import requests
 from constants import BASE_URLS, PONS_LANGUAGES_TO_CODES, PONS_CODES_TO_LANGUAGES
 from exceptions import (LanguageNotSupportedException,
-                                        TranslationNotFound,
-                                        NotValidPayload,
-                                        ElementNotFoundInGetRequest,
-                                        RequestError,
-                                        TooManyRequests)
+                        TranslationNotFound,
+                        NotValidPayload,
+                        ElementNotFoundInGetRequest,
+                        RequestError,
+                        TooManyRequests)
 from parent import BaseTranslator
 from requests.utils import requote_uri
 

deep_translator/yandex.py

@@ -3,9 +3,7 @@ Yandex translator API
 """
 import requests
 from constants import BASE_URLS
-from exceptions import (RequestError,
-                        ServerException, TranslationNotFound, TooManyRequests)
-
+from exceptions import (RequestError, ServerException, TranslationNotFound, TooManyRequests)
 
 class YandexTranslator(object):
     """