added support for linguee.

HISTORY.rst

@@ -2,6 +2,6 @@
 History
 =======
 
-0.1.4 stable release
+0.3.1 stable release
 ---------------------
 

README.rst

@@ -49,26 +49,45 @@ Usage
 
 .. code-block:: python
 
-    from deep_translator import GoogleTranslator
+    from deep_translator import GoogleTranslator, PonsTranslator, LingueeTranslator
 
     english_text = 'happy coding'
 
-    # first create a GoogleTranslator object with source and target language
-    # then use the translate function to translate a text.
-    # All language are supported. Basic example:
-
     result_german = GoogleTranslator(source='auto', target='de').translate(payload=english_text)
 
     # Alternatively, you can pass languages by their name:
-    result_german = GoogleTranslator(source='english', target='german').translate(payload=english_text)
+    translated = GoogleTranslator(source='english', target='german').translate(payload=english_text)
 
-    ##################### or maybe you want to translate a text file ? #############################
-    translated_text = GoogleTranslator(source='auto', target='german').translate_file('path/to/file')
+    # or maybe you want to translate a text file ?
+    translated = GoogleTranslator(source='auto', target='german').translate_file('path/to/file')
 
     # or maybe you have many sentences in different languages and want to automate the translation process
     translated = GoogleTranslator(source='auto', target='de').translate_sentences(your_list_of_sentences)
 
-    ###################### or use Pons as a translator  ###########################
+
+or maybe you would like to use the Pons translator: Pons.com
+
+
+.. code-block:: python
+
     word = 'good'
     translated_word = PonsTranslator(source='english', target='french').translate(word)
 
+    # set the argument return_all to True if you want to get all synonyms of the word to translate
+    translated_word = PonsTranslator(source='english', target='french').translate(word, return_all=True)
+
+
+Alternatively deep_translator now supports the Linguee translator:
+
+
+.. code-block:: python
+
+    word = 'good'
+    translated_word = LingueeTranslator(source='english', target='french').translate(word)
+
+    # set the argument return_all to True if you want to get all synonyms of the word to translate
+    translated_word = PonsTranslator(source='english', target='french').translate(word, return_all=True)
+
+Take a look in the examples folder for more :)
+
+Please contribute and give me a feedback if you found the package useful/helpful or you are using it :)

deep_translator/__init__.py

@@ -2,10 +2,10 @@
 
 from .google_trans import GoogleTranslator
 from .pons import PonsTranslator
+from .linguee import LingueeTranslator
 
 __author__ = """Nidhal Baccouri"""
 __email__ = '[email protected]'
-__version__ = '0.1.3'
+__version__ = '0.3.1'
 
-__all__ = [GoogleTranslator,
-           PonsTranslator]
+__all__ = [GoogleTranslator, PonsTranslator, LingueeTranslator]

deep_translator/tests/test_deep_translator.py

@@ -7,13 +7,22 @@ from deep_translator import exceptions, GoogleTranslator
 
 
 @pytest.fixture
-def response():
+def google_translator():
     """Sample pytest fixture.
 
     See more at: http://doc.pytest.org/en/latest/fixture.html
     """
-    translator = GoogleTranslator(target='en')
-    assert translator.translate(payload='좋은') == "good"
+    return GoogleTranslator(target='en')
+
+
+def test_content(google_translator):
+    """Sample pytest test function with the pytest fixture as an argument."""
+    # from bs4 import BeautifulSoup
+    # assert 'GitHub' in BeautifulSoup(response.content).title.string
+    assert google_translator.translate(payload='좋은') == "good"
+
+
+def test_inputs():
     with pytest.raises(exceptions.LanguageNotSupportedException):
         GoogleTranslator(source="", target="")
 
@@ -21,7 +30,10 @@ def response():
         GoogleTranslator(source="auto", target="nothing")
 
 
-def test_content(response):
-    """Sample pytest test function with the pytest fixture as an argument."""
-    # from bs4 import BeautifulSoup
-    # assert 'GitHub' in BeautifulSoup(response.content).title.string
+def test_payload(google_translator):
+    with pytest.raises(exceptions.NotValidPayload):
+        google_translator.translate(payload="")
+    with pytest.raises(exceptions.NotValidPayload):
+        google_translator.translate(payload=123)
+
+

docs/usage.rst

@@ -2,24 +2,43 @@
 Usage
 =====
 
-
 .. code-block:: python
 
-    from deep_translator import GoogleTranslator, PonsTranslator
+    from deep_translator import GoogleTranslator, PonsTranslator, LingueeTranslator
 
     english_text = 'happy coding'
 
-    # first create a GoogleTranslator object with source and target language
-    # then use the translate function to translate a text.
-    # All language are supported. Basic example:
-
     result_german = GoogleTranslator(source='auto', target='de').translate(payload=english_text)
 
-
     # Alternatively, you can pass languages by their name:
-    result_german = GoogleTranslator(source='english', target='german').translate(payload=english_text)
+    translated = GoogleTranslator(source='english', target='german').translate(payload=english_text)
+
+    # or maybe you want to translate a text file ?
+    translated = GoogleTranslator(source='auto', target='german').translate_file('path/to/file')
+
+    # or maybe you have many sentences in different languages and want to automate the translation process
+    translated = GoogleTranslator(source='auto', target='de').translate_sentences(your_list_of_sentences)
+
+
+or maybe you would like to use the Pons translator: Pons.com
+
+
+.. code-block:: python
 
-    ###################### Use Pons as a translator  ###########################
     word = 'good'
     translated_word = PonsTranslator(source='english', target='french').translate(word)
 
+    # set the argument return_all to True if you want to get all synonyms of the word to translate
+    translated_word = PonsTranslator(source='english', target='french').translate(word, return_all=True)
+
+
+Alternatively deep_translator now supports the Linguee translator:
+
+
+.. code-block:: python
+
+    word = 'good'
+    translated_word = LingueeTranslator(source='english', target='french').translate(word)
+
+    # set the argument return_all to True if you want to get all synonyms of the word to translate
+    translated_word = PonsTranslator(source='english', target='french').translate(word, return_all=True)

examples/trans.py

@@ -1,10 +1,23 @@
-from deep_translator import GoogleTranslator
+from deep_translator import GoogleTranslator, PonsTranslator, LingueeTranslator
+
+
+# examples using google translate
 
 english_text = 'happy coding'
 chinese_text = '這很好'
+
 result_german = GoogleTranslator(source='english', target='german').translate(payload=english_text)
 result_french = GoogleTranslator(source='auto', target='french').translate(payload=chinese_text)
 
 print(f"original english text: {english_text} | translated text: {result_german}")  # result: fröhliche Codierung
 print(f"original chinese text: {chinese_text} | translated text: {result_french}")  # result: C' est bon
 
+# examples using linguee:
+text = 'cute'
+translated = LingueeTranslator(source='english', target='german').translate(word=text)
+print("Using Linguee ==> the translated text: ", translated)
+
+# examples using pons:
+text = 'good'
+translated = PonsTranslator(source='english', target='arabic').translate(word=text)
+print("using Pons ==> the translated text: ", translated)

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.3
+current_version = 0.3.1
 commit = True
 tag = True
 

setup.py

@@ -51,6 +51,6 @@ setup(
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/nidhaloff/deep_translator',
-    version='0.1.3',
+    version='0.3.1',
     zip_safe=False,
 )