Merge pull request #65 from nidhaloff/platform-agnostic-refactoring-&-cli-testing

README.rst

@@ -647,7 +647,7 @@ Next Steps
 
 Take a look in the examples folder for more :)
 Contributions are always welcome.
-Read the Contribution guildlines `Here <https://deep-translator.readthedocs.io/en/latest/contributing.html/>`_
+Read the Contribution guidelines `Here <https://deep-translator.readthedocs.io/en/latest/contributing.html/>`_
 
 ==========
 Credits
@@ -673,7 +673,7 @@ The Translator++ mobile app
     :alt: Icon of the app
 
 
-After developing the deep_translator, I realised how cool this would be if I can use it as an app on my mobile phone.
+After developing the deep_translator, I realized how cool this would be if I can use it as an app on my mobile phone.
 Sure, there is google translate, pons and linguee apps etc.. but isn't it cooler to make an app where all these
 translators are integrated?
 

deep_translator/__init__.py

@@ -1,5 +1,6 @@
-"""Top-level package for deep_translator."""
+"""Top-level package for Deep Translator"""
 
+# TODO: Discussion: Do these need to be in __init__.py? Are they intended to be exportable?
 from .google_trans import GoogleTranslator
 from .pons import PonsTranslator
 from .linguee import LingueeTranslator
@@ -10,18 +11,19 @@ from .deepl import DeepL
 from .detection import single_detection, batch_detection
 from .microsoft import MicrosoftTranslator
 
+# 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.4.4'
-
-__all__ = [GoogleTranslator,
-           PonsTranslator,
-           LingueeTranslator,
-           MyMemoryTranslator,
-           YandexTranslator,
-           MicrosoftTranslator,
-           QCRI,
-           DeepL,
-           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,6 +13,58 @@ from .papago import PapagoTranslator
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
+@click.command(name='Deep Translator', 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")
+@click.option(
+    "--languages",
+    "-lang",
+    is_flag=True,
+    help="list all the languages available with the translator."
+    " Run with deep_translator <translator service> -lang",)
+def main(translator, source, target, text, api_key, languages):
+    """
+    Use TRANSLATOR to translate source material into another language.
+    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):
     """
@@ -65,7 +117,6 @@ def translate(translator, source, target, text, api_key):
     click.echo(f" | Translation from {source} to {target} |")
     click.echo(f"Translated text: \n {res}")
 
-
 def print_supported_languages(requested_translator, api_key):
     """
     function used to print the languages supported by the translator service
@@ -102,63 +153,5 @@ def print_supported_languages(requested_translator, api_key):
     for k, v in supported_languages.items():
         click.echo(f"|- {k}: {v}")
 
-
-@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.option(
-    "--source",
-    "-src",
-    type=str,
-    help="source language to translate from"
-)
-@click.option(
-    "--target",
-    "-tg",
-    type=str,
-    help="target language to translate to"
-)
-@click.option(
-    "--text",
-    "-txt",
-    type=str,
-    help="text you want to translate"
-)
-@click.option(
-    "--api-key",
-    type=str,
-    help="required for DeepL, QCRI, Yandex, Microsoft and Papago translators"
-)
-@click.option(
-    "--languages",
-    "-lang",
-    is_flag=True,
-    help="list all the languages available with the translator."
-    " Run with deep_translator -trans <translator service> -lang",
-)
-def main(translator, source, target, text, api_key, languages):
-    """
-    \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()
-
-
 if __name__ == "__main__":
-    main()
+    main()

deep_translator/deepl.py

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

deep_translator/detection.py

@@ -2,7 +2,7 @@
 language detection API
 """
 import requests
-from deep_translator.configs import config
+from .configs import config # TODO: Discussion: Could this be moved here and remove configs.py entirely?
 from requests.exceptions import HTTPError
 
 

deep_translator/exceptions.py

@@ -82,7 +82,7 @@ class NotValidLength(BaseError):
 
 class RequestError(Exception):
     """
-    exception thrown if an error occured during the request call, e.g a connection problem.
+    exception thrown if an error occurred during the request call, e.g a connection problem.
     """
 
     def __init__(self, message="Request exception can happen due to an api connection error. "
@@ -108,7 +108,7 @@ class MicrosoftAPIerror(Exception):
 
 class TooManyRequests(Exception):
     """
-    exception thrown if an error occured during the request call, e.g a connection problem.
+    exception thrown if an error occurred during the request call, e.g a connection problem.
     """
 
     def __init__(self, message="Server Error: You made too many requests to the server. According to google, you are allowed to make 5 requests per second and up to 200k requests per day. You can wait and try again later or you can try the translate_batch function"):

deep_translator/google_trans.py

@@ -2,9 +2,9 @@
 google translator API
 """
 
-from deep_translator.constants import BASE_URLS, GOOGLE_LANGUAGES_TO_CODES
-from deep_translator.exceptions import TooManyRequests, LanguageNotSupportedException, TranslationNotFound, NotValidPayload, RequestError
-from deep_translator.parent import BaseTranslator
+from .constants import BASE_URLS, GOOGLE_LANGUAGES_TO_CODES
+from .exceptions import TooManyRequests, LanguageNotSupportedException, TranslationNotFound, NotValidPayload, RequestError
+from .parent import BaseTranslator
 from bs4 import BeautifulSoup
 import requests
 from time import sleep

deep_translator/linguee.py

@@ -2,14 +2,14 @@
 linguee translator API
 """
 
-from deep_translator.constants import BASE_URLS, LINGUEE_LANGUAGES_TO_CODES, LINGUEE_CODE_TO_LANGUAGE
-from deep_translator.exceptions import (LanguageNotSupportedException,
-                                        TranslationNotFound,
-                                        NotValidPayload,
-                                        ElementNotFoundInGetRequest,
-                                        RequestError,
-                                        TooManyRequests)
-from deep_translator.parent import BaseTranslator
+from .constants import BASE_URLS, LINGUEE_LANGUAGES_TO_CODES, LINGUEE_CODE_TO_LANGUAGE
+from .exceptions import (LanguageNotSupportedException,
+                        TranslationNotFound,
+                        NotValidPayload,
+                        ElementNotFoundInGetRequest,
+                        RequestError,
+                        TooManyRequests)
+from .parent import BaseTranslator
 from bs4 import BeautifulSoup
 import requests
 from requests.utils import requote_uri

deep_translator/microsoft.py

@@ -4,8 +4,8 @@ import requests
 import logging
 import sys
 
-from deep_translator.constants import BASE_URLS, MICROSOFT_CODES_TO_LANGUAGES
-from deep_translator.exceptions import LanguageNotSupportedException, ServerException, MicrosoftAPIerror
+from .constants import BASE_URLS, MICROSOFT_CODES_TO_LANGUAGES
+from .exceptions import LanguageNotSupportedException, ServerException, MicrosoftAPIerror
 
 
 class MicrosoftTranslator:

deep_translator/mymemory.py

@@ -4,13 +4,13 @@ mymemory translator API
 import logging
 import warnings
 
-from deep_translator.constants import BASE_URLS, GOOGLE_LANGUAGES_TO_CODES
-from deep_translator.exceptions import (NotValidPayload,
-                                        TranslationNotFound,
-                                        LanguageNotSupportedException,
-                                        RequestError,
-                                        TooManyRequests)
-from deep_translator.parent import BaseTranslator
+from .constants import BASE_URLS, GOOGLE_LANGUAGES_TO_CODES
+from .exceptions import (NotValidPayload,
+                        TranslationNotFound,
+                        LanguageNotSupportedException,
+                        RequestError,
+                        TooManyRequests)
+from .parent import BaseTranslator
 import requests
 from time import sleep
 

deep_translator/papago.py

@@ -2,8 +2,8 @@
 google translator API
 """
 import json
-from deep_translator.constants import BASE_URLS, PAPAGO_LANGUAGE_TO_CODE
-from deep_translator.exceptions import LanguageNotSupportedException, TranslationNotFound, NotValidPayload
+from .constants import BASE_URLS, PAPAGO_LANGUAGE_TO_CODE
+from .exceptions import LanguageNotSupportedException, TranslationNotFound, NotValidPayload
 import requests
 import warnings
 import logging

deep_translator/parent.py

@@ -1,10 +1,8 @@
 """parent translator class"""
 
-from deep_translator.exceptions import NotValidPayload, NotValidLength, InvalidSourceOrTargetLanguage
+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

@@ -3,14 +3,14 @@ pons translator API
 """
 from bs4 import BeautifulSoup
 import requests
-from deep_translator.constants import BASE_URLS, PONS_LANGUAGES_TO_CODES, PONS_CODES_TO_LANGUAGES
-from deep_translator.exceptions import (LanguageNotSupportedException,
-                                        TranslationNotFound,
-                                        NotValidPayload,
-                                        ElementNotFoundInGetRequest,
-                                        RequestError,
-                                        TooManyRequests)
-from deep_translator.parent import BaseTranslator
+from .constants import BASE_URLS, PONS_LANGUAGES_TO_CODES, PONS_CODES_TO_LANGUAGES
+from .exceptions import (LanguageNotSupportedException,
+                        TranslationNotFound,
+                        NotValidPayload,
+                        ElementNotFoundInGetRequest,
+                        RequestError,
+                        TooManyRequests)
+from .parent import BaseTranslator
 from requests.utils import requote_uri
 
 

deep_translator/qcri.py

@@ -1,9 +1,7 @@
 
 import requests
-from deep_translator.constants import BASE_URLS, QCRI_LANGUAGE_TO_CODE
-from deep_translator.exceptions import (
-                                        ServerException, TranslationNotFound)
-
+from .constants import BASE_URLS, QCRI_LANGUAGE_TO_CODE
+from .exceptions import (ServerException, TranslationNotFound)
 
 class QCRI(object):
     """

deep_translator/tests/test_cli.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+"""Tests for the CLI interface."""
+
+from click.testing import CliRunner
+from deep_translator import __main__
+
+def results_test():
+    runner = CliRunner()
+    result = runner.invoke(__main__.main, [ '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.'])
+    assert api_error.exit_code == 0
+    assert api_error == "This translator requires an api key provided through --api-key"

deep_translator/utils.py

@@ -1,3 +1,4 @@
 """
 utilities
 """
+# TODO: Discussion: Whats the purpsoe of this module?

deep_translator/yandex.py

@@ -2,10 +2,8 @@
 Yandex translator API
 """
 import requests
-from deep_translator.constants import BASE_URLS
-from deep_translator.exceptions import (RequestError,
-                                        ServerException, TranslationNotFound, TooManyRequests)
-
+from .constants import BASE_URLS
+from .exceptions import (RequestError, ServerException, TranslationNotFound, TooManyRequests)
 
 class YandexTranslator(object):
     """

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -1,3 +1,58 @@
+#main config
+[metadata]
+name = Deep Translator
+version = 1.4.4
+url = https://github.com/nidhaloff/deep_translator
+author = Nidhal Baccouri
+author_email = [email protected]
+maintainer = Nidhal Baccouri
+maintainer_email = [email protected]
+classifiers =         
+    Development Status :: 5 - Production/Stable,
+    Intended Audience :: Developers,
+    Intended Audience :: Education,
+    Intended Audience :: Information Technology,
+    License :: OSI Approved :: MIT License,
+    Topic :: Education,
+    Topic :: Software Development,
+    Topic :: Communications,
+    Topic :: Text Processing,
+    Topic :: Text Processing :: Linguistic,
+    Natural Language :: English,
+    Operating System :: OS Independent,
+    Programming Language :: Python :: 3,
+    Programming Language :: Python :: 3.5,
+    Programming Language :: Python :: 3.6,
+    Programming Language :: Python :: 3.7,
+    Programming Language :: Python :: 3.8
+license = MIT
+license_files = file:LICENSE
+description = A flexible python tool to translate between different languages in a simple way.
+long_description = file:README.rst
+long_description_content_type = text/rst
+keywords = deep_translator, deepL, DeepL, translator, translation, automation, 
+    web scraping, google translator, google translation, google trans, PONS, 
+    YANDEX, MyMemory translator, Linguee, QCRI, Language, Language detection, 
+    detect language, free translation, unlimited translation, translate for free
+
+# [options]
+# zip_safe = 0
+# setup_requires = pytest-runner
+# install_requires = requests; beautifulsoup4; click
+# python_requires = >=3.0
+# tests_require = pytest>=3
+# include_package_data = 1
+# packages = find:
+# package_dir = =deep_translator
+
+# [options.entry_points]
+# console_scripts = deep-translator = deep_translator.__main__:deep_translator
+#                 dt = deep_translator.__main__:deep_translator
+
+# [options.packages.find]
+# where = deep_translator
+
+# bumpversion config
 [bumpversion]
 current_version = 1.4.4
 commit = True
@@ -11,16 +66,15 @@ replace = version='{new_version}'
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
 
-[bdist_wheel]
-universal = 1
-
-[flake8]
-exclude = docs
+# [bdist_wheel]
+# universal = 1
 
-[aliases]
-# Define setup.py command aliases here
-test = pytest
+# [flake8]
+# exclude = docs
 
-[tool:pytest]
-collect_ignore = ['setup.py']
+# [aliases]
+# # Define setup.py command aliases here
+# test = pytest
 
+# [tool:pytest]
+# collect_ignore = [setup.py]

setup.py

@@ -1,75 +1,17 @@
-#!/usr/bin/env python
-
+# #!/usr/bin/env python
 """The setup script."""
-
 from setuptools import setup, find_packages
 
-with open('README.rst') as readme_file:
-    readme = readme_file.read()
-
-with open('HISTORY.rst') as history_file:
-    history = history_file.read()
-
-
-# with open('./re') as reqs:
-#     requirements = reqs.read()
-# print(requirements)
-# exit()
-setup_requirements = ['pytest-runner', ]
-
-test_requirements = ['pytest>=3', ]
-
 setup(
-    author="Nidhal Baccouri",
-    author_email='[email protected]',
-    maintainer="Nidhal Baccouri",
-    maintainer_email='[email protected]',
-    python_requires='>=3.0',
-    classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'Intended Audience :: Developers',
-        'Intended Audience :: Education',
-        'Intended Audience :: Information Technology',
-        'License :: OSI Approved :: MIT License',
-        'Topic :: Education',
-        'Topic :: Software Development',
-        'Topic :: Communications',
-        'Topic :: Text Processing',
-        'Topic :: Text Processing :: Linguistic',
-        'Natural Language :: English',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-    ],
-    description="A flexible python tool to translate between different languages in a simple way.",
-    entry_points={
-        'console_scripts': [
-            'deep_translator=deep_translator.cli:main',
-        ],
-    },
-    install_requires=['requests', 'beautifulsoup4'],
-    license="MIT license",
-    long_description=readme + '\n\n' + history,
-    include_package_data=True,
-    keywords=['deep_translator',
-              'deepL', 'DeepL',
-              'translator',
-              'translation',
-              'automation',
-              'web scraping',
-              'google translator', 'google translation', 'google trans',
-              'PONS', 'YANDEX', 'MyMemory translator', 'Linguee', 'QCRI',
-              'Language', 'Language detection', 'detect language',
-              'free translation', 'unlimited translation', 'translate for free'],
-    name='deep_translator',
-    packages=find_packages(include=['deep_translator']),
-    setup_requires=setup_requirements,
-    test_suite='tests',
-    tests_require=test_requirements,
-    url='https://github.com/nidhaloff/deep_translator',
-    version='1.4.4',
     zip_safe=False,
+    setup_requires=['pytest-runner',],
+    install_requires=['requests','beautifulsoup4','click',],
+    python_requires='>=3',
+    tests_require=['pytest>=3',],
+    include_package_data=True,
+    packages=find_packages(include=['deep_translator'],),
+    entry_points={'console_scripts':[
+        'deep-translator=deep_translator.__main__:main',
+        'dt=deep_translator.__main__:main',
+    ],},
 )