pre-final refactor commit. Builds clean. Minor grammar and syntax fixes remaining.

deep_translator/__init__.py

@@ -1,16 +1,17 @@
 """Top-level package for Deep Translator"""
 
-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
+# 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
+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
+# TODO: Discussion: These should be declared in setup.cfg, setting them here is redundant
 # __author__ = """Nidhal Baccouri"""
 # __email__ = '[email protected]'
 # __version__ = '1.4.4'

deep_translator/__main__.py

@@ -1,15 +1,15 @@
 """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
+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"])
 
@@ -41,18 +41,16 @@ CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 @click.option(
     "--api-key",
     type=str,
-    help="required for DeepL, QCRI, Yandex, Microsoft and Papago translators"
-)
+    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 deep_translator(translator, source, target, text, api_key, languages):
+    " 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.\n
+    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
@@ -156,4 +154,4 @@ def print_supported_languages(requested_translator, api_key):
         click.echo(f"|- {k}: {v}")
 
 if __name__ == "__main__":
-    deep_translator()
+    main()

deep_translator/deepl.py

@@ -1,6 +1,6 @@
 import requests
-from constants import BASE_URLS, DEEPL_LANGUAGE_TO_CODE
-from exceptions import (ServerException,
+from .constants import BASE_URLS, DEEPL_LANGUAGE_TO_CODE
+from .exceptions import (ServerException,
                         TranslationNotFound,
                         LanguageNotSupportedException,
                         AuthorizationException)

deep_translator/detection.py

@@ -2,7 +2,7 @@
 language detection API
 """
 import requests
-from 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/google_trans.py

@@ -2,9 +2,9 @@
 google translator API
 """
 
-from constants import BASE_URLS, GOOGLE_LANGUAGES_TO_CODES
-from exceptions import TooManyRequests, LanguageNotSupportedException, TranslationNotFound, NotValidPayload, RequestError
-from 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 constants import BASE_URLS, LINGUEE_LANGUAGES_TO_CODES, LINGUEE_CODE_TO_LANGUAGE
-from exceptions import (LanguageNotSupportedException,
+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 .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 constants import BASE_URLS, MICROSOFT_CODES_TO_LANGUAGES
-from 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 constants import BASE_URLS, GOOGLE_LANGUAGES_TO_CODES
-from exceptions import (NotValidPayload,
+from .constants import BASE_URLS, GOOGLE_LANGUAGES_TO_CODES
+from .exceptions import (NotValidPayload,
                         TranslationNotFound,
                         LanguageNotSupportedException,
                         RequestError,
                         TooManyRequests)
-from parent import BaseTranslator
+from .parent import BaseTranslator
 import requests
 from time import sleep
 

deep_translator/papago.py

@@ -2,8 +2,8 @@
 google translator API
 """
 import json
-from constants import BASE_URLS, PAPAGO_LANGUAGE_TO_CODE
-from 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,6 +1,6 @@
 """parent translator class"""
 
-from exceptions import NotValidPayload, NotValidLength, InvalidSourceOrTargetLanguage
+from .exceptions import NotValidPayload, NotValidLength, InvalidSourceOrTargetLanguage
 from abc import ABC, abstractmethod
 import string
 class BaseTranslator(ABC):

deep_translator/pons.py

@@ -3,14 +3,14 @@ pons translator API
 """
 from bs4 import BeautifulSoup
 import requests
-from constants import BASE_URLS, PONS_LANGUAGES_TO_CODES, PONS_CODES_TO_LANGUAGES
-from exceptions import (LanguageNotSupportedException,
+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 .parent import BaseTranslator
 from requests.utils import requote_uri
 
 

deep_translator/qcri.py

@@ -1,7 +1,7 @@
 
 import requests
-from constants import BASE_URLS, QCRI_LANGUAGE_TO_CODE
-from 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

@@ -1,9 +1,9 @@
 #!/usr/bin/env python
 
-"""Tests for `deep_translator` package."""
+"""Tests for the CLI interface."""
 
 from click.testing import CliRunner
-from deep_translator.cli import main
+from deep_translator import cli
 
 def results_test():
     runner = CliRunner()

deep_translator/utils.py

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

deep_translator/yandex.py

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

setup.cfg

@@ -35,22 +35,22 @@ keywords = deep_translator, deepL, DeepL, translator, translation, automation,
     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]
+# 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 = __main__:deep_translator
-                dt = __main__: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
+# [options.packages.find]
+# where = deep_translator
 
 # bumpversion config
 [bumpversion]

setup.py

@@ -0,0 +1,17 @@
+# #!/usr/bin/env python
+"""The setup script."""
+from setuptools import setup, find_packages
+
+setup(
+    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',
+    ],},
+)

setup.py.bak

@@ -1,76 +0,0 @@
-# #!/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 = cli:main',
-#             'dt = cli:main',
-#         ],
-#     },
-#     install_requires=['requests', 'beautifulsoup4', 'Click'],
-#     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,
-# )