Minor updates for package
- Change the package name to googletrans - reStructedText README for PyPI - Travis CI
This commit is contained in:
SuHun Han
ssut
parent
b128722a0d
commit
791e32a23b
10
.travis.yml
Normal file
10
.travis.yml
Normal file
@ -0,0 +1,10 @@
|
||||
language: python
|
||||
python:
|
||||
- 2.7
|
||||
- 3.6
|
||||
- pypy
|
||||
install:
|
||||
- pip install tox-travis
|
||||
- pip install pytest-cov coveralls
|
||||
script: tox
|
||||
after_success: coveralls
|
||||
1
MANIFEST.in
Normal file
1
MANIFEST.in
Normal file
@ -0,0 +1 @@
|
||||
include README.rst
|
||||
183
README.md
183
README.md
@ -1,183 +0,0 @@
|
||||
# Py-GoogleTrans
|
||||
|
||||
[](http://opensource.org/licenses/MIT)
|
||||
[](https://app.wercker.com/project/bykey/b888422b2e335c431f9a10bd8b2768cd)
|
||||
[](https://readthedocs.org/projects/py-googletrans/?badge=latest)
|
||||
[](http://badge.fury.io/py/py-googletrans)
|
||||
[](https://coveralls.io/r/ssut/py-googletrans)
|
||||
[](https://codeclimate.com/github/ssut/py-googletrans)
|
||||
|
||||
Py-GoogleTrans is a **free** and **unlimited** python library that implemented Google Translate API. This uses the [Google Translate Ajax API](https://translate.google.com) to make calls to such methods as detect and translate.
|
||||
|
||||
Compatible with Python 2.7+ and 3.4+ (cPython and PyPy. Py 2.6 and 3.3 are not tested yet.)
|
||||
|
||||
For details refer to the [API Documentation](https://py-googletrans.readthedocs.org/en/latest/googletrans.html).
|
||||
|
||||
## Features
|
||||
|
||||
- Fast and reliable - it uses the same servers that translate.google.com uses
|
||||
- Auto language detection
|
||||
- Bulk translations
|
||||
- Connection pooling (the advantage of using requests.Session)
|
||||
- HTTP/2 support
|
||||
|
||||
### TODO
|
||||
|
||||
more features are coming soon.
|
||||
|
||||
- Proxy support
|
||||
- Internal session management (for better bulk translations)
|
||||
- Customizable service URL (translate.google.***com***)
|
||||
|
||||
### HTTP/2 support
|
||||
|
||||
This is a great deal for everyone! (up to 2x times faster in my test) If you want to get googletrans faster you should install [hyper](https://github.com/Lukasa/hyper) package. Googletrans will automatically detect if hyper is installed and if so, it will be used for http networking.
|
||||
|
||||
### How does this library work
|
||||
|
||||
You may wondering why this library works properly, whereas other approaches such like goslate won't work since Google has updated its translation service recently with a ticket mechanism to prevent a lot of crawler programs.
|
||||
|
||||
I eventually figure out a way to generate a ticket by reverse engineering on the [obfuscated and minified code used by Google to generate such token](https://translate.google.com/translate/releases/twsfe_w_20170306_RC00/r/js/desktop_module_main.js), and implemented on the top of Python. However, this could be blocked at any time.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
To install, either use things like pip with the package "py-googletrans" or download the package and put the "googletrans" directory into your python path. Anyway, it is noteworthy that, this just requires two modules: requests and future.
|
||||
|
||||
```bash
|
||||
$ pip install py-googletrans
|
||||
```
|
||||
|
||||
## Basic Usage
|
||||
|
||||
If source language is not given, google translate attempts to detect the source language.
|
||||
|
||||
```python
|
||||
>>> from googletrans import translator
|
||||
>>> translator.translate('안녕하세요.')
|
||||
# <Translated src=ko dest=en text=Good evening. pronunciation=Good evening.>
|
||||
>>> translator.translate('안녕하세요.', dest='ja')
|
||||
# <Translated src=ko dest=ja text=こんにちは。 pronunciation=Kon'nichiwa.>
|
||||
>>> translator.translate('veritas lux mea', src='la')
|
||||
# <Translated src=la dest=en text=The truth is my light pronunciation=The truth is my light>
|
||||
```
|
||||
|
||||
### Advanced Usage (Bulk)
|
||||
|
||||
Array can be used to translate a batch of strings in a single method call and a single HTTP session. The exact same method shown above work for arrays as well.
|
||||
|
||||
```python
|
||||
>>> translations = translator.translate(['The quick brown fox', 'jumps over', 'the lazy dog'], dest='ko')
|
||||
>>> for translation in translations:
|
||||
... print(translation.origin, ' -> ', translation.text)
|
||||
# The quick brown fox -> 빠른 갈색 여우
|
||||
# jumps over -> 이상 점프
|
||||
# the lazy dog -> 게으른 개
|
||||
```
|
||||
|
||||
### Language detection
|
||||
|
||||
The detect method, as its name implies, identifies the language used in a given sentence.
|
||||
|
||||
```python
|
||||
>>> from googletrans import translator
|
||||
>>> translator.detect('이 문장은 한글로 쓰여졌습니다.')
|
||||
# <Detected lang=ko confidence=0.27041003>
|
||||
>>> translator.detect('この文章は日本語で書かれました。')
|
||||
# <Detected lang=ja confidence=0.64889508>
|
||||
>>> translator.detect('This sentence is written in English.')
|
||||
# <Detected lang=en confidence=0.22348526>
|
||||
>>> translator.detect('Tiu frazo estas skribita en Esperanto.')
|
||||
# <Detected lang=eo confidence=0.10538048>
|
||||
```
|
||||
|
||||
## GoogleTrans as a command line application
|
||||
|
||||
```bash
|
||||
$ translate -h
|
||||
usage: translate [-h] [-d DEST] [-s SRC] [-c] text
|
||||
|
||||
Python Google Translator as a command-line tool
|
||||
|
||||
positional arguments:
|
||||
text The text you want to translate.
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-d DEST, --dest DEST The destination language you want to translate.
|
||||
(Default: en)
|
||||
-s SRC, --src SRC The source language you want to translate. (Default:
|
||||
auto)
|
||||
-c, --detect
|
||||
|
||||
$ translate "veritas lux mea" -s la -d en
|
||||
[veritas] veritas lux mea
|
||||
->
|
||||
[en] The truth is my light
|
||||
[pron.] The truth is my light
|
||||
|
||||
$ translate -c "안녕하세요."
|
||||
[ko, 1] 안녕하세요.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Note on library usage
|
||||
|
||||
- The maximum character limit on a single text is 15k.
|
||||
|
||||
- Due to limitations of the web version of google translate, this API does not guarantee that the library would work properly at all times. (so please use this library if you don't care about stability.)
|
||||
|
||||
- If you want to use a stable API, I highly recommend you to use [Google's official translate API](https://cloud.google.com/translate/docs).
|
||||
|
||||
- If you get HTTP 5xx error or errors like #6, it's probably because Google has banned your client IP address.
|
||||
|
||||
---
|
||||
|
||||
## Versioning
|
||||
|
||||
This library follows [Semantic Versioning](http://semver.org/) from v2.0.0. Any release versioned 0.x.y is subject to backwards incompatible changes at any time.
|
||||
|
||||
## Submitting a Pull Request
|
||||
|
||||
Contributions to this library are always welcome and highly encouraged :)
|
||||
|
||||
1. Fork this project.
|
||||
2. Create a topic branch.
|
||||
3. Implement your feature or bug fix.
|
||||
4. Run `python tests.py` or `python -m unittest -v`.
|
||||
5. Add a test for yout feature or bug fix.
|
||||
6. Run step 4 again. If your changes are not 100% covered, go back to step 5.
|
||||
7. Commit and push your changes.
|
||||
8. Submit a pull request.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
Py-GoogleTrans is licensed under the MIT License. The terms are as follows:
|
||||
|
||||
```
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015 SuHun Han
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
241
README.rst
Normal file
241
README.rst
Normal file
@ -0,0 +1,241 @@
|
||||
Py-GoogleTrans
|
||||
==============
|
||||
|
||||
|GitHub license| |wercker status| |Documentation Status| |PyPI version|
|
||||
|Coverage Status| |Code Climate|
|
||||
|
||||
Py-GoogleTrans is a **free** and **unlimited** python library that
|
||||
implemented Google Translate API. This uses the `Google Translate Ajax
|
||||
API <https://translate.google.com>`__ to make calls to such methods as
|
||||
detect and translate.
|
||||
|
||||
Compatible with Python 2.7+ and 3.4+ (cPython and PyPy. Py 2.6 and 3.3
|
||||
are not tested yet.)
|
||||
|
||||
For details refer to the `API
|
||||
Documentation <https://py-googletrans.readthedocs.org/en/latest/googletrans.html>`__.
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- Fast and reliable - it uses the same servers that
|
||||
translate.google.com uses
|
||||
- Auto language detection
|
||||
- Bulk translations
|
||||
- Connection pooling (the advantage of using requests.Session)
|
||||
- HTTP/2 support
|
||||
|
||||
TODO
|
||||
~~~~
|
||||
|
||||
more features are coming soon.
|
||||
|
||||
- Proxy support
|
||||
- Internal session management (for better bulk translations)
|
||||
- Customizable service URL (translate.google.***com***)
|
||||
|
||||
HTTP/2 support
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
This is a great deal for everyone! (up to 2x times faster in my test) If
|
||||
you want to get googletrans faster you should install
|
||||
`hyper <https://github.com/Lukasa/hyper>`__ package. Googletrans will
|
||||
automatically detect if hyper is installed and if so, it will be used
|
||||
for http networking.
|
||||
|
||||
How does this library work
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You may wondering why this library works properly, whereas other
|
||||
approaches such like goslate won't work since Google has updated its
|
||||
translation service recently with a ticket mechanism to prevent a lot of
|
||||
crawler programs.
|
||||
|
||||
I eventually figure out a way to generate a ticket by reverse
|
||||
engineering on the `obfuscated and minified code used by Google to
|
||||
generate such
|
||||
token <https://translate.google.com/translate/releases/twsfe_w_20170306_RC00/r/js/desktop_module_main.js>`__,
|
||||
and implemented on the top of Python. However, this could be blocked at
|
||||
any time.
|
||||
|
||||
--------------
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
To install, either use things like pip with the package "googletrans"
|
||||
or download the package and put the "googletrans" directory into your
|
||||
python path. Anyway, it is noteworthy that, this just requires two
|
||||
modules: requests and future.
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ pip install googletrans
|
||||
|
||||
Basic Usage
|
||||
-----------
|
||||
|
||||
If source language is not given, google translate attempts to detect the
|
||||
source language.
|
||||
|
||||
.. code:: python
|
||||
|
||||
>>> from googletrans import translator
|
||||
>>> translator.translate('안녕하세요.')
|
||||
# <Translated src=ko dest=en text=Good evening. pronunciation=Good evening.>
|
||||
>>> translator.translate('안녕하세요.', dest='ja')
|
||||
# <Translated src=ko dest=ja text=こんにちは。 pronunciation=Kon'nichiwa.>
|
||||
>>> translator.translate('veritas lux mea', src='la')
|
||||
# <Translated src=la dest=en text=The truth is my light pronunciation=The truth is my light>
|
||||
|
||||
Advanced Usage (Bulk)
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Array can be used to translate a batch of strings in a single method
|
||||
call and a single HTTP session. The exact same method shown above work
|
||||
for arrays as well.
|
||||
|
||||
.. code:: python
|
||||
|
||||
>>> translations = translator.translate(['The quick brown fox', 'jumps over', 'the lazy dog'], dest='ko')
|
||||
>>> for translation in translations:
|
||||
... print(translation.origin, ' -> ', translation.text)
|
||||
# The quick brown fox -> 빠른 갈색 여우
|
||||
# jumps over -> 이상 점프
|
||||
# the lazy dog -> 게으른 개
|
||||
|
||||
Language detection
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The detect method, as its name implies, identifies the language used in
|
||||
a given sentence.
|
||||
|
||||
.. code:: python
|
||||
|
||||
>>> from googletrans import translator
|
||||
>>> translator.detect('이 문장은 한글로 쓰여졌습니다.')
|
||||
# <Detected lang=ko confidence=0.27041003>
|
||||
>>> translator.detect('この文章は日本語で書かれました。')
|
||||
# <Detected lang=ja confidence=0.64889508>
|
||||
>>> translator.detect('This sentence is written in English.')
|
||||
# <Detected lang=en confidence=0.22348526>
|
||||
>>> translator.detect('Tiu frazo estas skribita en Esperanto.')
|
||||
# <Detected lang=eo confidence=0.10538048>
|
||||
|
||||
GoogleTrans as a command line application
|
||||
-----------------------------------------
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ translate -h
|
||||
usage: translate [-h] [-d DEST] [-s SRC] [-c] text
|
||||
|
||||
Python Google Translator as a command-line tool
|
||||
|
||||
positional arguments:
|
||||
text The text you want to translate.
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-d DEST, --dest DEST The destination language you want to translate.
|
||||
(Default: en)
|
||||
-s SRC, --src SRC The source language you want to translate. (Default:
|
||||
auto)
|
||||
-c, --detect
|
||||
|
||||
$ translate "veritas lux mea" -s la -d en
|
||||
[veritas] veritas lux mea
|
||||
->
|
||||
[en] The truth is my light
|
||||
[pron.] The truth is my light
|
||||
|
||||
$ translate -c "안녕하세요."
|
||||
[ko, 1] 안녕하세요.
|
||||
|
||||
--------------
|
||||
|
||||
Note on library usage
|
||||
---------------------
|
||||
|
||||
- The maximum character limit on a single text is 15k.
|
||||
|
||||
- Due to limitations of the web version of google translate, this API
|
||||
does not guarantee that the library would work properly at all times.
|
||||
(so please use this library if you don't care about stability.)
|
||||
|
||||
- If you want to use a stable API, I highly recommend you to use
|
||||
`Google's official translate
|
||||
API <https://cloud.google.com/translate/docs>`__.
|
||||
|
||||
- If you get HTTP 5xx error or errors like #6, it's probably because
|
||||
Google has banned your client IP address.
|
||||
|
||||
--------------
|
||||
|
||||
Versioning
|
||||
----------
|
||||
|
||||
This library follows `Semantic Versioning <http://semver.org/>`__ from
|
||||
v2.0.0. Any release versioned 0.x.y is subject to backwards incompatible
|
||||
changes at any time.
|
||||
|
||||
Submitting a Pull Request
|
||||
-------------------------
|
||||
|
||||
Contributions to this library are always welcome and highly encouraged
|
||||
:)
|
||||
|
||||
1. Fork this project.
|
||||
2. Create a topic branch.
|
||||
3. Implement your feature or bug fix.
|
||||
4. Run ``python tests.py`` or ``python -m unittest -v``.
|
||||
5. Add a test for yout feature or bug fix.
|
||||
6. Run step 4 again. If your changes are not 100% covered, go back to
|
||||
step 5.
|
||||
7. Commit and push your changes.
|
||||
8. Submit a pull request.
|
||||
|
||||
--------------
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Py-GoogleTrans is licensed under the MIT License. The terms are as
|
||||
follows:
|
||||
|
||||
::
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015 SuHun Han
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
.. |GitHub license| image:: https://img.shields.io/github/license/mashape/apistatus.svg
|
||||
:target: http://opensource.org/licenses/MIT
|
||||
.. |wercker status| image:: https://app.wercker.com/status/b888422b2e335c431f9a10bd8b2768cd/s
|
||||
:target: https://app.wercker.com/project/bykey/b888422b2e335c431f9a10bd8b2768cd
|
||||
.. |Documentation Status| image:: https://readthedocs.org/projects/py-googletrans/badge/?version=latest
|
||||
:target: https://readthedocs.org/projects/py-googletrans/?badge=latest
|
||||
.. |PyPI version| image:: https://badge.fury.io/py/py-googletrans.svg
|
||||
:target: http://badge.fury.io/py/py-googletrans
|
||||
.. |Coverage Status| image:: https://coveralls.io/repos/ssut/py-googletrans/badge.svg
|
||||
:target: https://coveralls.io/r/ssut/py-googletrans
|
||||
.. |Code Climate| image:: https://codeclimate.com/github/ssut/py-googletrans/badges/gpa.svg
|
||||
:target: https://codeclimate.com/github/ssut/py-googletrans
|
||||
@ -1,2 +1 @@
|
||||
requests==2.13.0
|
||||
future==0.14.3
|
||||
|
||||
44
setup.py
44
setup.py
@ -1,16 +1,27 @@
|
||||
#!/usr/bin/env python
|
||||
import googletrans
|
||||
import os.path
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
|
||||
def readme():
|
||||
path = os.path.join(os.path.dirname(__file__), 'README.rst')
|
||||
try:
|
||||
with open(path) as f:
|
||||
return f.read()
|
||||
except IOError:
|
||||
pass
|
||||
|
||||
|
||||
def install():
|
||||
desc = googletrans.__doc__
|
||||
setup(
|
||||
name='py-googletrans',
|
||||
version='1.2',
|
||||
description=desc,
|
||||
long_description=desc,
|
||||
name='googletrans',
|
||||
version=googletrans.__version__,
|
||||
description=googletrans.__doc__,
|
||||
long_description=readme(),
|
||||
license='MIT',
|
||||
author='SuHun Han',
|
||||
author_email='ssut@ssut.me',
|
||||
author_email='ssut' '@' 'ssut.me',
|
||||
url='https://github.com/ssut/py-googletrans',
|
||||
classifiers=['Development Status :: 5 - Production/Stable',
|
||||
'Intended Audience :: Education',
|
||||
@ -21,18 +32,25 @@ def install():
|
||||
'Operating System :: MacOS :: MacOS X',
|
||||
'Topic :: Education',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 2.6',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Programming Language :: Python :: 3.2',
|
||||
'Programming Language :: Python :: 3.3',
|
||||
'Programming Language :: Python :: 3.4'],
|
||||
packages=find_packages(),
|
||||
'Programming Language :: Python :: 3.4',
|
||||
'Programming Language :: Python :: 3.5',
|
||||
'Programming Language :: Python :: 3.6'],
|
||||
packages=find_packages(exclude=['docs', 'tests']),
|
||||
keywords='google translate translator',
|
||||
install_requires=[
|
||||
'requests',
|
||||
'future',
|
||||
],
|
||||
scripts=['translate'],
|
||||
extras_require={
|
||||
'h2': ['hyper'],
|
||||
},
|
||||
tests_require=[
|
||||
'pytest',
|
||||
'coveralls',
|
||||
],
|
||||
scripts=['translate']
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
install()
|
||||
19
tox.ini
19
tox.ini
@ -1,5 +1,18 @@
|
||||
[tox]
|
||||
envlist = py27,py34,pypy
|
||||
envlist = py27,py36,pypy
|
||||
|
||||
[testenv]
|
||||
deps=coveralls
|
||||
commands=coverage run --source=googletrans tests.py -v
|
||||
deps=
|
||||
-r{toxinidir}/requirements.txt
|
||||
pytest
|
||||
pytest-capturelog
|
||||
pytest-cov
|
||||
commands=
|
||||
py.test --cov-report= --cov={envsitepackagesdir}/googletrans {posargs:}
|
||||
|
||||
[pytest]
|
||||
addopts = -v
|
||||
testpaths = googletrans/ tests/
|
||||
|
||||
[flake8]
|
||||
exclude = .tox
|
||||
|
||||
Loading…
Reference in New Issue
Block a user