File size: 29,842 Bytes
09af6bc 01ec7b4 09af6bc 3e848bc f420bc0 05a3c2c a6786b3 f72c2ae 01ec7b4 d958e41 01ec7b4 363d508 3e848bc 33c1179 d958e41 750f6a2 f72c2ae d958e41 028c38f ce978f1 028c38f d958e41 028c38f 57badcd ce978f1 dac50b2 531ed25 ce978f1 531ed25 3e848bc 222e59a 3e848bc 4379cba 2bbab3f 790d8de 3e848bc 790d8de 531ed25 3e848bc 222e59a 3e848bc 16bac78 0e35eb5 3e848bc 0e35eb5 5a168b7 3e848bc 790d8de 37ef637 790d8de 37ef637 3dcf81b 37ef637 9cde6b7 37ef637 790d8de 37ef637 790d8de 8ab0bea 16bac78 3dcf81b 16bac78 37ef637 9cde6b7 37ef637 9b73ac8 8ab0bea 97c5727 37ef637 790d8de 3e848bc 790d8de 3e848bc a6888ed 50181c5 a6888ed c006992 f89616a 07b82a7 a887ba6 3dcf81b 97c5727 8593ca0 9a69a65 9450a60 5a168b7 f123cfb 3e848bc 790d8de 0d45729 f420bc0 0d45729 001213c 0d45729 f8a770b 9450a60 001213c 9450a60 3dcf81b 9450a60 7167a1f 1aab85c 3dcf81b 7167a1f 97c5727 1aab85c 97c5727 7167a1f ed150d4 37d3379 4a4fa23 7167a1f 790d8de 3e848bc f8a770b 790d8de 8ab0bea 3dcf81b 790d8de 8593ca0 5a40797 9a69a65 f8a770b 1aab85c 3dcf81b 3ac6e56 8850921 1600811 07b82a7 f89616a 09af6bc f8a770b 790d8de 8593ca0 5a40797 8850921 283a7d3 5a40797 1b424c6 283a7d3 1b424c6 283a7d3 790d8de 8593ca0 790d8de 9cde6b7 09af6bc 9cde6b7 09af6bc 9cde6b7 09af6bc 5a40797 790d8de f4c7330 0e35eb5 2316fd5 790d8de 8ab0bea 790d8de 1600811 790d8de 09ff866 8ab0bea f8a770b 1600811 790d8de 2e421d6 4379cba 16bac78 2e421d6 4379cba 2e421d6 7055243 2e421d6 7055243 2e421d6 7055243 2e421d6 7055243 2e421d6 7055243 2e421d6 1600811 0e35eb5 1600811 9a69a65 1600811 a6786b3 0e35eb5 4119be8 0e35eb5 1600811 790d8de 4119be8 9a69a65 8ab0bea c754d32 790d8de 8ab0bea 790d8de 8ab0bea 790d8de 8ab0bea c754d32 1600811 c754d32 8ab0bea f8a770b 8ab0bea 1600811 790d8de 4119be8 790d8de 8ab0bea c754d32 9562deb 68aa657 9562deb f89616a f1c6875 9562deb f89616a cf48558 9562deb f89616a 9562deb 68aa657 1f09504 f89616a 1f09504 f89616a 1f09504 f89616a 1f09504 f89616a 1f09504 c754d32 790d8de f4c7330 c754d32 790d8de c754d32 16bac78 790d8de c754d32 bce6760 c754d32 7167a1f 790d8de 8ab0bea 790d8de 8ab0bea bce6760 c754d32 8ab0bea 16bac78 8ab0bea 7167a1f 790d8de 5d13bbd bce6760 c006992 8d18691 c006992 16bac78 c006992 1600811 c006992 1600811 c006992 1600811 01ef7d5 d3bc8a9 81442fa d3bc8a9 16bac78 d3bc8a9 01ef7d5 d3bc8a9 3dcf81b bd52cd0 3dcf81b bd52cd0 3dcf81b b8b57c9 4a4fa23 38a149c 8cda8c5 38a149c 3dcf81b 8cda8c5 3dcf81b 07b82a7 16bac78 07b82a7 a887ba6 616a476 37d3379 a887ba6 37d3379 46d68d5 37d3379 5d6c522 6a8c939 b32a994 6a8c939 5d6c522 b32a994 5d6c522 a887ba6 bf1ba51 16bac78 bf1ba51 1aab85c bf1ba51 9450a60 bf1ba51 4119be8 1600811 f123cfb f4c7330 f123cfb f420bc0 f123cfb f420bc0 f123cfb f420bc0 f123cfb f420bc0 f123cfb f420bc0 f123cfb f420bc0 f123cfb b8b57c9 f123cfb f420bc0 40fe929 b8b57c9 40fe929 023cf2c f420bc0 023cf2c f420bc0 023cf2c f420bc0 023cf2c 407967c 023cf2c b77f050 ce3ad77 f4c7330 948c3ff f4c7330 68aa657 f4c7330 45b7e7d f4c7330 b888b8b 1b6c336 b888b8b 9b73ac8 f420bc0 9b73ac8 ec8e9cd 9b73ac8 f420bc0 834048f 9b73ac8 834048f f420bc0 9b73ac8 f420bc0 9b73ac8 834048f 9b73ac8 f420bc0 9b73ac8 834048f 9b73ac8 f420bc0 9b73ac8 834048f 9b73ac8 f420bc0 9b73ac8 2e421d6 16bac78 2e421d6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 |
##################
deep-translator
##################
.. image:: ../assets/icon.jpg
:width: 100
:align: center
:alt: deep-translator-icon
|
.. image:: https://img.shields.io/pypi/v/deep-translator.svg
:target: https://pypi.python.org/pypi/deep-translator
.. image:: https://img.shields.io/travis/nidhaloff/deep-translator.svg
:target: https://github.com/nidhaloff/deep-translator/actions/workflows/build.yml
.. image:: https://readthedocs.org/projects/deep-translator/badge/?version=latest
:target: https://deep-translator.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/l/deep-translator
:target: https://pypi.python.org/pypi/deep-translator
.. image:: https://img.shields.io/pypi/status/deep-translator
:target: https://pypi.python.org/pypi/deep-translator
.. image:: https://pepy.tech/badge/deep-translator
:target: https://pepy.tech/project/deep-translator
.. image:: https://img.shields.io/pypi/wheel/deep-translator
:target: https://pypi.python.org/pypi/deep-translator
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
:target: https://github.com/pre-commit/pre-commit
.. image:: https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FNidhalBaccouri
:alt: Twitter URL
:target: https://twitter.com/NidhalBaccouri
=======================
Translation for humans
=======================
A flexible **FREE** and **UNLIMITED** tool to translate between different languages in a simple way using multiple translators.
* Free software: MIT license
* Documentation: https://deep-translator.readthedocs.io.
* Swagger API: https://deep-translator-api.azurewebsites.net/docs.
|
|
.. contents:: Table of Contents
:depth: 3
|
|
==========
Motivation
==========
I needed to translate a text using python. It was hard to find a simple way to do it.
There are other libraries that can be used for this task, but most of them
are **buggy, not free, limited, not supported anymore or complex to use.**
Therefore, I decided to build this simple tool. It is 100% free, unlimited, easy to use and provides
support for all languages.
Basically, my goal was to integrate support for multiple famous translators
in this tool.
======================
When you should use it
======================
- If you want to translate text using python
- If you want to translate from a file
- If you want to get translations from many sources and not only one
- If you want to automate translations
- If you want to use ChatGpt for translations
- If you want to compare different translations
- If you want to detect language automatically
======================
Why you should use it
======================
- It's the only python tool that integrates many translators
- Multi language support
- Support for ChatGpt (version >= 1.11.0)
- Supports batch translation
- High level of abstraction
- Automatic language detection
- Easy to use and extend
- Support for most famous universal translators
- Stable and maintained regularly
- The API is very easy to use
- Proxy integration is supported
========
Features
========
* Support for `google translate <https://translate.google.com/>`_
* Support for the `microsoft translator <https://www.microsoft.com/en-us/translator//>`_ (version >= 1.3.5)
* Support for `Pons translator <https://de.pons.com/>`_
* Support for the `Linguee translator <https://www.linguee.com/>`_
* Support for the `Mymemory translator <https://mymemory.translated.net/>`_
* Support for the `Yandex translator <https://yandex.com/>`_ (version >= 1.2.1)
* Support for the `QcriTranslator translator <https://mt.qcri.org/api/>`_ (version >= 1.2.4)
* Support for the `DeeplTranslator translator <https://www.deepl.com/en/translator/>`_ (version >= 1.2.5)
* Support for the `Papago translator <https://papago.naver.com/>`_ (version >= 1.4.4)
* Support for the `Libre translator <https://libretranslate.com/>`_
* Support for ChatGpt
* Support for proxy usage
* Automatic single language detection
* Batch language detection
* Translate directly from a text file
* Translate docx files (version >= 1.9.4)
* Translate PDF files (version >= 1.9.4)
* Get multiple translation for a word
* Automate the translation of different paragraphs in different languages
* Translate directly from terminal (version >= 1.1.0)
=============
Installation
=============
Install the stable release:
.. code-block:: console
$ pip install -U deep-translator
$ poetry add deep-translator # for poetry usage
take a look at the docs if you want to install from source.
Also, you can install extras if you want support for specific use case. For example, translating Docx and PDF files
.. code-block:: console
$ pip install deep-translator[docx] # add support for docx translation
$ pip install deep-translator[pdf] # add support for pdf translation
$ pip install deep-translator[ai] # add support for ChatGpt
$ poetry add deep-translator --extras "docx pdf ai" # for poetry usage
============
Quick Start
============
.. code-block:: python
from deep_translator import GoogleTranslator
# Use any translator you like, in this example GoogleTranslator
translated = GoogleTranslator(source='auto', target='de').translate("keep it up, you are awesome") # output -> Weiter so, du bist großartig
or using proxies:
.. code-block:: python
from deep_translator import GoogleTranslator
proxies_example = {
"https": "34.195.196.27:8080",
"http": "34.195.196.27:8080"
}
translated = GoogleTranslator(source='auto', target='de', proxies=proxies_example).translate("keep it up, you are awesome") # output -> Weiter so, du bist großartig
or even directly from terminal:
.. code-block:: console
$ deep-translator --source "en" --target "de" --text "hello world"
or shorter
$ dt --translator chatgpt -tg de -txt "hello world"
=====
Usage
=====
In this section, demos on how to use all different integrated translators in this tool are provided.
.. note::
You can always pass the languages by the name or by abbreviation.
*Example*: If you want to use english as a source or target language, you can pass **english** or **en** as an argument
.. note::
For all translators that require an ApiKey, you can either specify it as an argument to the translator class
or you can export it as an environment variable, this way you won't have to provide it to the class.
*Example*: export OPENAI_API_KEY="your_key"
Imports
--------
.. code-block:: python
from deep_translator import (GoogleTranslator,
ChatGptTranslator,
MicrosoftTranslator,
PonsTranslator,
LingueeTranslator,
MyMemoryTranslator,
YandexTranslator,
PapagoTranslator,
DeeplTranslator,
QcriTranslator,
single_detection,
batch_detection)
Check Supported Languages
---------------------------
.. note::
You can check the supported languages of each translator by calling the
get_supported_languages function.
.. code-block:: python
# default return type is a list
langs_list = GoogleTranslator().get_supported_languages() # output: [arabic, french, english etc...]
# alternatively, you can the dictionary containing languages mapped to their abbreviation
langs_dict = GoogleTranslator().get_supported_languages(as_dict=True) # output: {arabic: ar, french: fr, english:en etc...}
Language Detection
------------------
.. note::
You can also detect language automatically. Notice that this package is free and my goal is to keep it free.
Therefore, you will need to get your own api_key if you want to use the language detection function.
I figured out you can get one for free here: https://detectlanguage.com/documentation
- Single Text Detection
.. code-block:: python
lang = single_detection('bonjour la vie', api_key='your_api_key')
print(lang) # output: fr
- Batch Detection
.. code-block:: python
lang = batch_detection(['bonjour la vie', 'hello world'], api_key='your_api_key')
print(lang) # output: [fr, en]
Google Translate
-----------------
.. code-block:: python
text = 'happy coding'
- You can use automatic language detection to detect the source language:
.. code-block:: python
translated = GoogleTranslator(source='auto', target='de').translate(text=text)
- You can pass languages by name or by abbreviation:
.. code-block:: python
translated = GoogleTranslator(source='auto', target='german').translate(text=text)
# Alternatively, you can pass languages by their abbreviation:
translated = GoogleTranslator(source='en', target='de').translate(text=text)
- You can also reuse the Translator class and change/update its properties.
(Notice that this is important for performance too, since instantiating new objects is expensive)
.. code-block:: python
# let's say first you need to translate from auto to german
my_translator = GoogleTranslator(source='auto', target='german')
result = my_translator.translate(text=text)
print(f"Translation using source = {my_translator.source} and target = {my_translator.target} -> {result}")
# let's say later you want to reuse the class but your target is french now
# This is the best practice and how you should use deep-translator.
# Please don't over-instantiate translator objects without a good reason, otherwise you will run into performance issues
my_translator.target = 'fr' # this will override the target 'german' passed previously
result = my_translator.translate(text=text)
print(f"Translation using source = {my_translator.source} and target = {my_translator.target} -> {result}")
# you can also update the source language as well
my_translator.source = 'en' # this will override the source 'auto' passed previously
result = my_translator.translate(text=text)
print(f"Translation using source = {my_translator.source} and target = {my_translator.target} -> {result}")
- 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 = GoogleTranslator('de', 'en').translate_batch(texts)
- Translate text from txt/docx/pdf:
.. code-block:: python
path = "your_file.txt"
translated = GoogleTranslator(source='auto', target='german').translate_file(path)
Mymemory Translator
--------------------
.. note::
As in google translate, you can use the automatic language detection with mymemory by using "auto" as an
argument for the source language. However, this feature in the mymemory translator is not so powerful as
in google translate.
- Simple translation
.. code-block:: python
text = 'Keep it up. You are awesome'
translated = MyMemoryTranslator(source='auto', target='french').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 = MyMemoryTranslator('de', 'en').translate_batch(texts)
- Translate text from txt/docx/pdf:
.. code-block:: python
path = "your_file.txt"
translated = MyMemoryTranslator(source='en', target='fr').translate_file(path)
DeeplTranslator
-----------------
.. note::
In order to use the DeeplTranslator translator, you need to generate an api key. Deepl offers a Pro and a free API.
deep-translator supports both Pro and free APIs. Just check the examples below.
Visit https://www.deepl.com/en/docs-api/ for more information on how to generate your Deepl api key
- Simple translation
.. code-block:: python
text = 'Keep it up. You are awesome'
translated = DeeplTranslator(api_key="your_api_key", source="en", target="en", use_free_api=True).translate(text)
.. note::
deep-translator uses free deepl api by default. If you have the pro version then simply set the use_free_api to false.
- 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 = DeeplTranslator("your_api_key").translate_batch(texts)
QcriTranslator
--------------------
.. note::
In order to use the QcriTranslator translator, you need to generate a free api key. Visit https://mt.qcri.org/api/
for more information
- Check languages
.. code-block:: python
# as a property
print("language pairs: ", QcriTranslator("your_api_key").languages)
- Check domains
.. code-block:: python
# as a property
print("domains: ", QcriTranslator("your_api_key").domains)
- Text translation
.. code-block:: python
text = 'Education is great'
translated = QcriTranslator("your_api_key").translate(source='en', target='ar', domain="news", text=text)
# output -> التعليم هو عظيم
# see docs for batch translation and more.
Linguee Translator
-------------------
.. code-block:: python
word = 'good'
- Simple Translation
.. code-block:: python
translated_word = LingueeTranslator(source='english', target='french').translate(word)
- Return all synonyms or words that match
.. code-block:: python
# set the argument return_all to True if you want to get all synonyms of the word to translate
translated_word = LingueeTranslator(source='english', target='french').translate(word, return_all=True)
- Translate a batch of words
.. code-block:: python
translated_words = LingueeTranslator(source='english', target='french').translate_words(["good", "awesome"])
PONS Translator
----------------
.. note::
You can pass the languages by the name or by abbreviation just like
previous examples using GoogleTranslate
.. code-block:: python
word = 'awesome'
- Simple Translation
.. code-block:: python
translated_word = PonsTranslator(source='english', target='french').translate(word)
# pass language by their abbreviation
translated_word = PonsTranslator(source='en', target='fr').translate(word)
- Return all synonyms or words that match
.. code-block:: python
# 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)
- Translate a batch of words
.. code-block:: python
translated_words = PonsTranslator(source='english', target='french').translate_words(["good", "awesome"])
Yandex Translator
------------------
.. note::
You need to require a **private api key** if you want to use the yandex translator.
Visit the official website for more information about how to get one
- Language detection
.. code-block:: python
lang = YandexTranslator('your_api_key').detect('Hallo, Welt')
print(f"language detected: {lang}") # output -> language detected: 'de'
- Text translation
.. code-block:: python
# with auto detection | meaning provide only the target language and let yandex detect the source
translated = YandexTranslator('your_api_key').translate(source="auto", target="en", text='Hallo, Welt')
print(f"translated text: {translated}") # output -> translated text: Hello world
# provide source and target language explicitly
translated = YandexTranslator('your_api_key').translate(source="de", target="en", text='Hallo, Welt')
print(f"translated text: {translated}") # output -> translated text: Hello world
- File translation
.. code-block:: python
translated = YandexTranslator('your_api_key').translate_file(source="auto", target="en", path="path_to_your_file")
- Batch translation
.. code-block:: python
translated = YandexTranslator('your_api_key').translate_batch(source="auto", target="de", batch=["hello world", "happy coding"])
Microsoft Translator
---------------------
.. note::
You need to require an **api key** if you want to use the microsoft translator.
Visit the official website for more information about how to get one.
Microsoft offers a free tier 0 subscription (2 million characters per month).
- Required and optional attributes
There are two required attributes, namely "api_key" (string) and "target" (string or list).
Attribute "source" is optional.
Also, Microsoft API accepts a number of other optional attributes, you can find them here: https://docs.microsoft.com/azure/cognitive-services/translator/reference/v3-0-translate
You can simply add them after the required attributes, see the example.
.. code-block:: python
text = 'happy coding'
translated = MicrosoftTranslator(api_key='some-key', target='de').translate(text=text)
translated_two_targets = MicrosoftTranslator(api_key='some-key', target=['de', 'ru']).translate(text=text)
translated_with_optional_attr = MicrosoftTranslator(api_key='some-key', target='de', textType='html']).translate(text=text)
- You can pass languages by name or by abbreviation:
.. code-block:: python
translated = MicrosoftTranslator(api_key='some-key', target='german').translate(text=text)
# Alternatively, you can pass languages by their abbreviation:
translated = MicrosoftTranslator(api_key='some-key', target='de').translate(text=text)
- Translate batch of texts
.. code-block:: python
texts = ["hallo welt", "guten morgen"]
translated = MicrosoftTranslator(api_key='some-key', target='english').translate_batch(texts)
- Translate from a file:
.. code-block:: python
translated = MicrosoftTranslator(api_key='some-key', target='german').translate_file('path/to/file')
ChatGpt Translator
---------------------
.. note::
You need to install the openai support extra. `pip install deep-translator[ai]`
.. note::
You need to require an **api key** if you want to use the ChatGpt translator.
If you have an openai account, you can create an api key (https://platform.openai.com/account/api-keys).
- Required and optional attributes
There are two required attributes, namely "api_key" (string) and "target" (string or list).
Attribute "source" is optional.
You can provide your api key, api base as an argument or you can export it as an env var
e.g.
`export OPENAI_API_KEY="your_key"`
`export OPENAI_API_BASE=https://api.openai.com/v1`
.. code-block:: python
text = 'happy coding'
translated = ChatGptTranslator(api_key='your_key', base_url='https://api.xxx.com/v1', target='german').translate(text=text)
- Translate batch of texts
.. code-block:: python
texts = ["hallo welt", "guten morgen"]
translated = ChatGptTranslator(api_key='some-key', target='english').translate_batch(texts)
- Translate from a file:
.. code-block:: python
translated = ChatGptTranslator(api_key='some-key', target='german').translate_file('path/to/file')
Papago Translator
---------------------
.. note::
You need to require a **client id** and **client secret key** if you want to use the papago translator.
Visit the official website for more information about how to get one.
.. code-block:: python
text = 'happy coding'
translated = PapagoTranslator(client_id='your_client_id', secret_key='your_secret_key', source='en', target='ko').translate(text=text) # output: 행복한 부호화
Libre Translator
---------------------
.. note::
Libre translate has multiple `mirrors <https://github.com/LibreTranslate/LibreTranslate#mirrors>`_ which can be used for the API endpoint.
Some require an API key to be used. By default the base url is set to `libretranslate.de <https://libretranslate.de/>`_ .
This can be set using the "base_url" input parameter.
.. code-block:: python
text = 'laufen'
translated = LibreTranslator(source='auto', target='en', base_url = 'https://libretranslate.com/', api_key = 'your_api_key').translate(text=text) # output: run
- You can pass languages by name or by abbreviation:
.. code-block:: python
translated = LibreTranslator(source='german', target='english').translate(text=text)
# Alternatively, you can pass languages by their abbreviation:
translated = LibreTranslator(source='de', target='en').translate(text=text)
- Translate batch of texts
.. code-block:: python
texts = ["hallo welt", "guten morgen"]
translated = LibreTranslator(source='auto', target='en').translate_batch(texts)
- Translate from a file:
.. code-block:: python
translated = LibreTranslator(source='auto', target='en').translate_file('path/to/file')
TencentTranslator
-----------------
.. note::
In order to use the TencentTranslator translator, you need to generate a secret_id and a secret_key.
deep-translator supports both Pro and free APIs. Just check the examples below.
Visit https://cloud.tencent.com/document/api/551/15619 for more information on how to generate your Tencent secret_id
and secret_key.
- Simple translation
.. code-block:: python
text = 'Hello world'
translated = TencentTranslator(secret_id="your-secret_id", secret_key="your-secret_key" source="en", target="zh").translate(text)
- Translate batch of texts
.. code-block:: python
texts = ["Hello world", "How are you?"]
translated = TencentTranslator(secret_id="your-secret_id", secret_key="your-secret_key" source="en", target="zh").translate_batch(texts)
- Translate from a file:
.. code-block:: python
translated = TencentTranslator(secret_id="your-secret_id", secret_key="your-secret_key" source="en", target="zh").translate_file('path/to/file')
BaiduTranslator
-----------------
.. note::
In order to use the BaiduTranslator translator, you need to generate a secret_id and a secret_key.
deep-translator supports both Pro and free APIs. Just check the examples below.
Visit http://api.fanyi.baidu.com/product/113 for more information on how to generate your Baidu appid
and appkey.
- Simple translation
.. code-block:: python
text = 'Hello world'
translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate(text)
- Translate batch of texts
.. code-block:: python
texts = ["Hello world", "How are you?"]
translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate_batch(texts)
- Translate from a file:
.. code-block:: python
translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate_file('path/to/file')
BaiduTranslator
-----------------
.. note::
In order to use the BaiduTranslator translator, you need to generate a secret_id and a secret_key.
deep-translator supports both Pro and free APIs. Just check the examples below.
Visit http://api.fanyi.baidu.com/product/113 for more information on how to generate your Baidu appid
and appkey.
- Simple translation
.. code-block:: python
text = 'Hello world'
translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate(text)
- Translate batch of texts
.. code-block:: python
texts = ["Hello world", "How are you?"]
translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate_batch(texts)
- Translate from a file:
.. code-block:: python
translated = BaiduTranslator(appid="your-appid", appkey="your-appkey" source="en", target="zh").translate_file('path/to/file')
Proxy usage
-------------
deep-translator provides out of the box usage of proxies. Just define your proxies config as a dictionary
and pass it to the corresponding translator. Below is an example using the GoogleTranslator, but this feature
can be used with all supported translators.
.. code-block:: python
from deep_translator import GoogleTranslator
# define your proxy configs:
proxies_example = {
"https": "your https proxy", # example: 34.195.196.27:8080
"http": "your http proxy if available"
}
translated = GoogleTranslator(source='auto', target='de', proxies=proxies_example).translate("this package is awesome")
File Translation
--------------------
Deep-translator (version >= 1.9.4) supports not only text file translation, but docx and PDF files too.
However, you need to install deep-translator using the specific extras.
For docx translation:
.. code-block:: console
pip install deep-translator[docx]
For PDF translation:
.. code-block:: console
pip install deep-translator[pdf]
- Translate text from txt/docx/pdf:
Here is sample code for translating text directly from files
.. code-block:: python
path = "example/test.pdf"
translated = GoogleTranslator(source='auto', target='german').translate_file(path)
Usage from Terminal
--------------------
Deep-translator supports a series of command line arguments for quick and simple access to the translators directly in your console.
.. note::
The program accepts ``deep-translator`` or ``dt`` as a command, feel free to substitute whichever you prefer.
For a list of available translators:
.. code-block:: console
$ deep-translator list
To translate a string or line of text:
.. code-block:: console
$ deep_translator --translator google --source "english" --target "german" --text "happy coding"
$
Alternate short option names, along with using language abbreviations:
.. code-block:: console
$ dt -trans google -src "en" -tg "de" -txt "happy coding"
$ dt -trans chatgpt -src "en" -tg "ja" -txt "happy coding"
Finally, to retrieve a list of available languages for a given translator:
.. code-block:: console
$ deep-translator languages google
======
Tests
======
Developers can install the development version of deep-translator and execute unit tests to verify functionality. For more information on doing this, see `the contribution guidelines <https://deep-translator.readthedocs.io/en/latest/contributing.html#get-started>`_
========
Links
========
Check this article on medium to know why you should use the deep-translator package and how to translate text using python.
https://medium.com/@nidhalbacc/how-to-translate-text-with-python-9d203139dcf5
======
Help
======
If you are facing any problems, please feel free to open an issue.
Additionally, you can make contact with the author for further information/questions.
Do you like deep-translator?
You can always help the development of this project by:
- Following on github and/or twitter
- Promote the project (ex: by giving it a star on github)
- Watch the github repo for new releases
- Tweet about the package
- Help others with issues on github
- Create issues and pull requests
- Sponsor the project
===========
Next Steps
===========
Take a look in the examples folder for more :)
Contributions are always welcome.
Read the Contribution guidelines `Here <https://deep-translator.readthedocs.io/en/latest/contributing.html#get-started>`_
==========
Credits
==========
Many thanks to @KirillSklyarenko for his work on integrating the microsoft translator
==========
License
==========
MIT license
Copyright (c) 2020-present, Nidhal Baccouri
===========
Swagger UI
===========
deep-translator offers an api server for easy integration with other applications. Non python applications
can communicate with the api directly and leverage the features of deep-translator
Access the api here: https://deep-translator-api.azurewebsites.net/docs
===========================
The Translator++ mobile app
===========================
.. image:: ../assets/app-icon.png
:width: 100
:alt: Icon of the app
You can download and try the app on play store https://play.google.com/store/apps/details?id=org.translator.translator&hl=en_US&gl=US
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?
Long story short, I started working on the app. I decided to use the `kivy framework <https://kivy.org/#home/>`_ since
I wanted to code in python and to develop a cross platform app.
I open sourced the `Translator++ app <https://github.com/nidhaloff/deep-translator-app/>`_ on my github too.
Feel free to take a look at the code or make a pull request ;)
.. note::
The Translator++ app is based on the deep-translator package. I just built the app to prove the capabilities
of the deep-translator package ;)
I published the first release on google play store on 02-08-2020
Here are some screenshots:
- Phone
.. image:: ../assets/translator1.jpg
:width: 30%
:height: 200
:alt: screenshot1
.. image:: ../assets/translator2.jpg
:width: 30%
:height: 200
:alt: screenshot2
.. image:: ../assets/spinner.jpg
:width: 30%
:height: 200
:alt: spinner
- Tablet:
.. image:: ../assets/hz_view.png
:width: 100%
:height: 300
:alt: screenshot3
===========================
Website & Desktop app
===========================
Currently, there are propositions for a website and/or desktop app based on deep-translator.
You can follow the issue here: https://github.com/nidhaloff/deep-translator/issues/144
|