Updated docs
Browse files- docs/deep_translator.rst +133 -0
- docs/usage.rst +37 -0
docs/deep_translator.rst
ADDED
@@ -0,0 +1,133 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
deep\_translator package
|
2 |
+
========================
|
3 |
+
|
4 |
+
Submodules
|
5 |
+
----------
|
6 |
+
|
7 |
+
deep\_translator.constants module
|
8 |
+
---------------------------------
|
9 |
+
|
10 |
+
.. automodule:: deep_translator.constants
|
11 |
+
:members:
|
12 |
+
:undoc-members:
|
13 |
+
:show-inheritance:
|
14 |
+
|
15 |
+
deep\_translator.deepl module
|
16 |
+
-----------------------------
|
17 |
+
|
18 |
+
.. automodule:: deep_translator.deepl
|
19 |
+
:members:
|
20 |
+
:undoc-members:
|
21 |
+
:show-inheritance:
|
22 |
+
|
23 |
+
deep\_translator.detection module
|
24 |
+
---------------------------------
|
25 |
+
|
26 |
+
.. automodule:: deep_translator.detection
|
27 |
+
:members:
|
28 |
+
:undoc-members:
|
29 |
+
:show-inheritance:
|
30 |
+
|
31 |
+
deep\_translator.exceptions module
|
32 |
+
----------------------------------
|
33 |
+
|
34 |
+
.. automodule:: deep_translator.exceptions
|
35 |
+
:members:
|
36 |
+
:undoc-members:
|
37 |
+
:show-inheritance:
|
38 |
+
|
39 |
+
deep\_translator.google\_trans module
|
40 |
+
-------------------------------------
|
41 |
+
|
42 |
+
.. automodule:: deep_translator.google_trans
|
43 |
+
:members:
|
44 |
+
:undoc-members:
|
45 |
+
:show-inheritance:
|
46 |
+
|
47 |
+
deep\_translator.libre module
|
48 |
+
-----------------------------
|
49 |
+
|
50 |
+
.. automodule:: deep_translator.libre
|
51 |
+
:members:
|
52 |
+
:undoc-members:
|
53 |
+
:show-inheritance:
|
54 |
+
|
55 |
+
deep\_translator.linguee module
|
56 |
+
-------------------------------
|
57 |
+
|
58 |
+
.. automodule:: deep_translator.linguee
|
59 |
+
:members:
|
60 |
+
:undoc-members:
|
61 |
+
:show-inheritance:
|
62 |
+
|
63 |
+
deep\_translator.main module
|
64 |
+
----------------------------
|
65 |
+
|
66 |
+
.. automodule:: deep_translator.main
|
67 |
+
:members:
|
68 |
+
:undoc-members:
|
69 |
+
:show-inheritance:
|
70 |
+
|
71 |
+
deep\_translator.microsoft module
|
72 |
+
---------------------------------
|
73 |
+
|
74 |
+
.. automodule:: deep_translator.microsoft
|
75 |
+
:members:
|
76 |
+
:undoc-members:
|
77 |
+
:show-inheritance:
|
78 |
+
|
79 |
+
deep\_translator.mymemory module
|
80 |
+
--------------------------------
|
81 |
+
|
82 |
+
.. automodule:: deep_translator.mymemory
|
83 |
+
:members:
|
84 |
+
:undoc-members:
|
85 |
+
:show-inheritance:
|
86 |
+
|
87 |
+
deep\_translator.papago module
|
88 |
+
------------------------------
|
89 |
+
|
90 |
+
.. automodule:: deep_translator.papago
|
91 |
+
:members:
|
92 |
+
:undoc-members:
|
93 |
+
:show-inheritance:
|
94 |
+
|
95 |
+
deep\_translator.parent module
|
96 |
+
------------------------------
|
97 |
+
|
98 |
+
.. automodule:: deep_translator.parent
|
99 |
+
:members:
|
100 |
+
:undoc-members:
|
101 |
+
:show-inheritance:
|
102 |
+
|
103 |
+
deep\_translator.pons module
|
104 |
+
----------------------------
|
105 |
+
|
106 |
+
.. automodule:: deep_translator.pons
|
107 |
+
:members:
|
108 |
+
:undoc-members:
|
109 |
+
:show-inheritance:
|
110 |
+
|
111 |
+
deep\_translator.qcri module
|
112 |
+
----------------------------
|
113 |
+
|
114 |
+
.. automodule:: deep_translator.qcri
|
115 |
+
:members:
|
116 |
+
:undoc-members:
|
117 |
+
:show-inheritance:
|
118 |
+
|
119 |
+
deep\_translator.yandex module
|
120 |
+
------------------------------
|
121 |
+
|
122 |
+
.. automodule:: deep_translator.yandex
|
123 |
+
:members:
|
124 |
+
:undoc-members:
|
125 |
+
:show-inheritance:
|
126 |
+
|
127 |
+
Module contents
|
128 |
+
---------------
|
129 |
+
|
130 |
+
.. automodule:: deep_translator
|
131 |
+
:members:
|
132 |
+
:undoc-members:
|
133 |
+
:show-inheritance:
|
docs/usage.rst
CHANGED
@@ -300,6 +300,43 @@ Yandex Translator
|
|
300 |
|
301 |
translated = YandexTranslator('your_api_key').translate_batch(source="auto", target="de", batch=["hello world", "happy coding"])
|
302 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
303 |
|
304 |
Usage from Terminal
|
305 |
--------------------
|
|
|
300 |
|
301 |
translated = YandexTranslator('your_api_key').translate_batch(source="auto", target="de", batch=["hello world", "happy coding"])
|
302 |
|
303 |
+
Libre Translator
|
304 |
+
---------------------
|
305 |
+
|
306 |
+
.. note::
|
307 |
+
|
308 |
+
Libre translate has multiple `mirrors <https://github.com/LibreTranslate/LibreTranslate#mirrors/>`_ which can be used for the API endpoint.
|
309 |
+
Some require an API key to be used. By default the base url is set to `libretranslate.de <https://libretranslate.de/>`_ .
|
310 |
+
This can be set using the "base_url" input parameter.
|
311 |
+
|
312 |
+
.. code-block:: python
|
313 |
+
|
314 |
+
text = 'laufen'
|
315 |
+
translated = LibreTranslator(source='auto', target='en', base_url = 'https://libretranslate.com/', api_key = 'your_api_key').translate(text=text) # output: run
|
316 |
+
|
317 |
+
|
318 |
+
- You can pass languages by name or by abbreviation:
|
319 |
+
|
320 |
+
.. code-block:: python
|
321 |
+
|
322 |
+
translated = LibreTranslator(source='german', target='english').translate(text=text)
|
323 |
+
|
324 |
+
# Alternatively, you can pass languages by their abbreviation:
|
325 |
+
translated = LibreTranslator(source='de', target='en').translate(text=text)
|
326 |
+
|
327 |
+
|
328 |
+
- Translate batch of texts
|
329 |
+
|
330 |
+
.. code-block:: python
|
331 |
+
|
332 |
+
texts = ["hallo welt", "guten morgen"]
|
333 |
+
translated = LibreTranslator(source='auto', target='en').translate_batch(texts)
|
334 |
+
|
335 |
+
- Translate from a file:
|
336 |
+
|
337 |
+
.. code-block:: python
|
338 |
+
|
339 |
+
translated = LibreTranslator(source='auto', target='en').translate_file('path/to/file')
|
340 |
|
341 |
Usage from Terminal
|
342 |
--------------------
|