updated docs

README.rst

@@ -155,6 +155,8 @@ Imports
                                  LingueeTranslator,
                                  MyMemoryTranslator,
                                  YandexTranslator,
+                                 DeepL,
+                                 QCRI,
                                  single_detection,
                                  batch_detection)
 
@@ -271,6 +273,32 @@ Mymemory Translator
 
     translated = MyMemoryTranslator(source='en', target='fr').translate_file(path)
 
+
+DeepL Translator
+-----------------
+
+.. note::
+
+    In order to use the DeepL translator, you need to generate an api key. Visit https://www.deepl.com/en/docs-api/
+    for more information
+
+- Simple translation
+
+.. code-block:: python
+
+    text = 'Keep it up. You are awesome'
+
+    translated = DeepL("your_api_key").translate(text)
+
+- Translate batch of texts
+
+.. code-block:: python
+
+    texts = ["hallo welt", "guten morgen"]
+
+    # the translate_sentences function is deprecated, use the translate_batch function instead
+    translated = DeepL("your_api_key").translate_batch(texts)
+
 QCRI Translator
 --------------------
 

deep_translator/__init__.py

@@ -12,7 +12,7 @@ from .detection import single_detection, batch_detection
 
 __author__ = """Nidhal Baccouri"""
 __email__ = '[email protected]'
-__version__ = '1.2.5'
+__version__ = '1.2.6'
 
 __all__ = [GoogleTranslator,
            PonsTranslator,

docs/usage.rst

@@ -16,15 +16,17 @@ Imports
 
 .. code-block:: python
 
+
     from deep_translator import (GoogleTranslator,
                                  PonsTranslator,
                                  LingueeTranslator,
                                  MyMemoryTranslator,
                                  YandexTranslator,
+                                 DeepL,
+                                 QCRI,
                                  single_detection,
                                  batch_detection)
 
-
 Check Supported Languages
 ---------------------------
 
@@ -138,6 +140,31 @@ Mymemory Translator
     translated = MyMemoryTranslator(source='en', target='fr').translate_file(path)
 
 
+DeepL Translator
+-----------------
+
+.. note::
+
+    In order to use the DeepL translator, you need to generate an api key. Visit https://www.deepl.com/en/docs-api/
+    for more information
+
+- Simple translation
+
+.. code-block:: python
+
+    text = 'Keep it up. You are awesome'
+
+    translated = DeepL("your_api_key").translate(text)
+
+- Translate batch of texts
+
+.. code-block:: python
+
+    texts = ["hallo welt", "guten morgen"]
+
+    # the translate_sentences function is deprecated, use the translate_batch function instead
+    translated = DeepL("your_api_key").translate_batch(texts)
+
 QCRI Translator
 --------------------
 

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.2.5
+current_version = 1.2.6
 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='1.2.5',
+    version='1.2.6',
     zip_safe=False,
 )