Package: deep-translator
Translation for humansA flexibleFREEandUNLIMITEDtool to translate between different languages in a simple way using multiple translators.Free software: MIT licenseDocumentation:https://deep-translator.readthedocs.io.Swagger API:https://deep-translator-api.azurewebsites.net/docs.Table of ContentsTranslation for humansMotivationWhen you should use itWhy you should use itFeaturesInstallationQuick StartUsageImportsCheck Supported LanguagesLanguage DetectionGoogle TranslateMymemory TranslatorDeeplTranslatorQcriTranslatorLinguee TranslatorPONS TranslatorYandex TranslatorMicrosoft TranslatorChatGpt TranslatorPapago TranslatorLibre TranslatorBaiduTranslatorBaiduTranslatorProxy usageFile TranslationUsage from TerminalTestsLinksHelpNext StepsCreditsLicenseSwagger UIThe Translator++ mobile appWebsite & Desktop appMotivationI 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
arebuggy, 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 itIf you want to translate text using pythonIf you want to translate from a fileIf you want to get translations from many sources and not only oneIf you want to automate translationsIf you want to use ChatGpt for translationsIf you want to compare different translationsIf you want to detect language automaticallyWhy you should use itIt’s the only python tool that integrates many translatorsMulti language supportSupport for ChatGpt (version >= 1.11.0)Supports batch translationHigh level of abstractionAutomatic language detectionEasy to use and extendSupport for most famous universal translatorsStable and maintained regularlyThe API is very easy to useProxy integration is supportedFeaturesSupport forgoogle translateSupport for themicrosoft translator(version >= 1.3.5)Support forPons translatorSupport for theLinguee translatorSupport for theMymemory translatorSupport for theYandex translator(version >= 1.2.1)Support for theQcriTranslator translator(version >= 1.2.4)Support for theDeeplTranslator translator(version >= 1.2.5)Support for thePapago translator(version >= 1.4.4)Support for theLibre translatorSupport for ChatGptSupport for proxy usageAutomatic single language detectionBatch language detectionTranslate directly from a text fileTranslate docx files (version >= 1.9.4)Translate PDF files (version >= 1.9.4)Get multiple translation for a wordAutomate the translation of different paragraphs in different languagesTranslate directly from terminal (version >= 1.1.0)InstallationInstall the stable release:$pipinstall-Udeep-translator$poetryadddeep-translator# for poetry usagetake 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$pipinstalldeep-translator[docx]# add support for docx translation$pipinstalldeep-translator[pdf]# add support for pdf translation$pipinstalldeep-translator[ai]# add support for ChatGpt$poetryadddeep-translator--extras"docx pdf ai"# for poetry usageQuick Startfromdeep_translatorimportGoogleTranslator# Use any translator you like, in this example GoogleTranslatortranslated=GoogleTranslator(source='auto',target='de').translate("keep it up, you are awesome")# output -> Weiter so, du bist großartigor using proxies:fromdeep_translatorimportGoogleTranslatorproxies_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ßartigor even directly from terminal:$deep-translator--source"en"--target"de"--text"hello world"or shorter$dt-tgde-txt"hello world"UsageIn this section, demos on how to use all different integrated translators in this tool are provided.NoteYou 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 passenglishorenas an argumentNoteFor 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”Importsfromdeep_translatorimport(GoogleTranslator,ChatGptTranslator,MicrosoftTranslator,PonsTranslator,LingueeTranslator,MyMemoryTranslator,YandexTranslator,PapagoTranslator,DeeplTranslator,QcriTranslator,single_detection,batch_detection)Check Supported LanguagesNoteYou can check the supported languages of each translator by calling the
get_supported_languages function.# default return type is a listlangs_list=GoogleTranslator().get_supported_languages()# output: [arabic, french, english etc...]# alternatively, you can the dictionary containing languages mapped to their abbreviationlangs_dict=GoogleTranslator().get_supported_languages(as_dict=True)# output: {arabic: ar, french: fr, english:en etc...}Language DetectionNoteYou 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/documentationSingle Text Detectionlang=single_detection('bonjour la vie',api_key='your_api_key')print(lang)# output: frBatch Detectionlang=batch_detection(['bonjour la vie','hello world'],api_key='your_api_key')print(lang)# output: [fr, en]Google Translatetext='happy coding'You can use automatic language detection to detect the source language:translated=GoogleTranslator(source='auto',target='de').translate(text=text)You can pass languages by name or by abbreviation: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)# let's say first you need to translate from auto to germanmy_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 issuesmy_translator.target='fr'# this will override the target 'german' passed previouslyresult=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 wellmy_translator.source='en'# this will override the source 'auto' passed previouslyresult=my_translator.translate(text=text)print(f"Translation using source ={my_translator.source}and target ={my_translator.target}->{result}")Translate batch of textstexts=["hallo welt","guten morgen"]# the translate_sentences function is deprecated, use the translate_batch function insteadtranslated=GoogleTranslator('de','en').translate_batch(texts)Translate from a file:translated=GoogleTranslator(source='auto',target='german').translate_file('path/to/file')Mymemory TranslatorNoteAs 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 translationtext='Keep it up. You are awesome'translated=MyMemoryTranslator(source='auto',target='french').translate(text)Translate batch of textstexts=["hallo welt","guten morgen"]# the translate_sentences function is deprecated, use the translate_batch function insteadtranslated=MyMemoryTranslator('de','en').translate_batch(texts)Translate from filepath="your_file.txt"translated=MyMemoryTranslator(source='en',target='fr').translate_file(path)DeeplTranslatorNoteIn 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.
Visithttps://www.deepl.com/en/docs-api/for more information on how to generate your Deepl api keySimple translationtext='Keep it up. You are awesome'translated=DeeplTranslator(api_key="your_api_key",source="en",target="en",use_free_api=True).translate(text)Notedeep-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 textstexts=["hallo welt","guten morgen"]# the translate_sentences function is deprecated, use the translate_batch function insteadtranslated=DeeplTranslator("your_api_key").translate_batch(texts)QcriTranslatorNoteIn order to use the QcriTranslator translator, you need to generate a free api key. Visithttps://mt.qcri.org/api/for more informationCheck languages# as a propertyprint("language pairs: ",QcriTranslator("your_api_key").languages)Check domains# as a propertyprint("domains: ",QcriTranslator("your_api_key").domains)Text translationtext='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 Translatorword='good'Simple Translationtranslated_word=LingueeTranslator(source='english',target='french').translate(word)Return all synonyms or words that match# set the argument return_all to True if you want to get all synonyms of the word to translatetranslated_word=LingueeTranslator(source='english',target='french').translate(word,return_all=True)Translate a batch of wordstranslated_words=LingueeTranslator(source='english',target='french').translate_words(["good","awesome"])PONS TranslatorNoteYou can pass the languages by the name or by abbreviation just like
previous examples using GoogleTranslateword='awesome'Simple Translationtranslated_word=PonsTranslator(source='english',target='french').translate(word)# pass language by their abbreviationtranslated_word=PonsTranslator(source='en',target='fr').translate(word)Return all synonyms or words that match# set the argument return_all to True if you want to get all synonyms of the word to translatetranslated_word=PonsTranslator(source='english',target='french').translate(word,return_all=True)Translate a batch of wordstranslated_words=PonsTranslator(source='english',target='french').translate_words(["good","awesome"])Yandex TranslatorNoteYou need to require aprivate api keyif you want to use the yandex translator.
Visit the official website for more information about how to get oneLanguage detectionlang=YandexTranslator('your_api_key').detect('Hallo, Welt')print(f"language detected:{lang}")# output -> language detected: 'de'Text translation# with auto detection | meaning provide only the target language and let yandex detect the sourcetranslated=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 explicitlytranslated=YandexTranslator('your_api_key').translate(source="de",target="en",text='Hallo, Welt')print(f"translated text:{translated}")# output -> translated text: Hello worldFile translationtranslated=YandexTranslator('your_api_key').translate_file(source="auto",target="en",path="path_to_your_file")Batch translationtranslated=YandexTranslator('your_api_key').translate_batch(source="auto",target="de",batch=["hello world","happy coding"])Microsoft TranslatorNoteYou need to require anapi keyif 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 attributesThere 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-translateYou can simply add them after the required attributes, see the example.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: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 textstexts=["hallo welt","guten morgen"]translated=MicrosoftTranslator(api_key='some-key',target='english').translate_batch(texts)Translate from a file:translated=MicrosoftTranslator(api_key='some-key',target='german').translate_file('path/to/file')ChatGpt TranslatorNoteYou need to install the openai support extra.pip install deep-translator[ai]NoteYou need to require anapi keyif 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 attributesThere are two required attributes, namely “api_key” (string) and “target” (string or list).
Attribute “source” is optional.You can provide your api key as an argument or you can export it as an env var
e.g.export OPENAI_API_KEY=”your_key”text='happy coding'translated=ChatGptTranslator(api_key='your_key',target='german').translate(text=text)Translate batch of textstexts=["hallo welt","guten morgen"]translated=ChatGptTranslator(api_key='some-key',target='english').translate_batch(texts)Translate from a file:translated=ChatGptTranslator(api_key='some-key',target='german').translate_file('path/to/file')Papago TranslatorNoteYou need to require aclient idandclient secret keyif you want to use the papago translator.
Visit the official website for more information about how to get one.text='happy coding'translated=PapagoTranslator(client_id='your_client_id',secret_key='your_secret_key',source='en',target='ko').translate(text=text)# output: 행복한 부호화Libre TranslatorNoteLibre translate has multiplemirrorswhich can be used for the API endpoint.
Some require an API key to be used. By default the base url is set tolibretranslate.de.
This can be set using the “base_url” input parameter.text='laufen'translated=LibreTranslator(source='auto',target='en',base_url='https://libretranslate.com/',api_key='your_api_key').translate(text=text)# output: runYou can pass languages by name or by abbreviation: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 textstexts=["hallo welt","guten morgen"]translated=LibreTranslator(source='auto',target='en').translate_batch(texts)Translate from a file:translated=LibreTranslator(source='auto',target='en').translate_file('path/to/file')BaiduTranslatorNoteIn 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.
Visithttp://api.fanyi.baidu.com/product/113for more information on how to generate your Baidu appid
and appkey.Simple translationtext='Hello world'translated=BaiduTranslator(appid="your-appid",appkey="your-appkey"source="en",target="zh").translate(text)Translate batch of textstexts=["Hello world","How are you?"]translated=BaiduTranslator(appid="your-appid",appkey="your-appkey"source="en",target="zh").translate_batch(texts)Translate from a file:translated=BaiduTranslator(appid="your-appid",appkey="your-appkey"source="en",target="zh").translate_file('path/to/file')BaiduTranslatorNoteIn 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.
Visithttp://api.fanyi.baidu.com/product/113for more information on how to generate your Baidu appid
and appkey.Simple translationtext='Hello world'translated=BaiduTranslator(appid="your-appid",appkey="your-appkey"source="en",target="zh").translate(text)Translate batch of textstexts=["Hello world","How are you?"]translated=BaiduTranslator(appid="your-appid",appkey="your-appkey"source="en",target="zh").translate_batch(texts)Translate from a file:translated=BaiduTranslator(appid="your-appid",appkey="your-appkey"source="en",target="zh").translate_file('path/to/file')Proxy usagedeep-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.fromdeep_translatorimportGoogleTranslator# 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 TranslationDeep-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:pip install deep-translator[docx]For PDF translation:pip install deep-translator[pdf]Usage from TerminalDeep-translator supports a series of command line arguments for quick and simple access to the translators directly in your console.NoteThe program acceptsdeep-translatorordtas a command, feel free to substitute whichever you prefer.For a list of available translators:$deep-translatorlistTo translate a string or line of text:$deep_translatorgoogle--source"english"--target"german"--text"happy coding"Alternate short option names, along with using language abbreviations:$deep_translatorgoogle-src"en"-tgt"de"-txt"happy coding"Finally, to retrieve a list of available languages for a given translator:$deep-translatorlanguagesgoogleTestsDevelopers can install the development version of deep-translator and execute unit tests to verify functionality. For more information on doing this, seethe contribution guidelinesLinksCheck 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-9d203139dcf5HelpIf 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 twitterPromote the project (ex: by giving it a star on github)Watch the github repo for new releasesTweet about the packageHelp others with issues on githubCreate issues and pull requestsSponsor the projectNext StepsTake a look in the examples folder for more :)
Contributions are always welcome.
Read the Contribution guidelinesHereCreditsMany thanks to @KirillSklyarenko for his work on integrating the microsoft translatorLicenseMIT licenseCopyright (c) 2020-present, Nidhal BaccouriSwagger UIdeep-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-translatorAccess the api here:https://deep-translator-api.azurewebsites.net/docsThe Translator++ mobile appYou can download and try the app on play storehttps://play.google.com/store/apps/details?id=org.translator.translator&hl=en_US&gl=USAfter 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 thekivy frameworksince
I wanted to code in python and to develop a cross platform app.
I open sourced theTranslator++ appon my github too.
Feel free to take a look at the code or make a pull request ;)NoteThe 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-2020Here are some screenshots:PhoneTablet:Website & Desktop appCurrently, 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