Merge pull request #14 from senk8/translate_jpa

ja/CONTRIBUTING.rst

@@ -0,0 +1,123 @@
+.. highlight:: shell
+
+============
+コントリビュートする方法
+============
+
+このプロジェクトではあなたのコントリビュートを歓迎します！どんなに小さい貢献でも、コントリビューターとしてプロジェクトを支援することができます。
+
+次の方法でコントリビュートすることができます。
+
+コントリビュートの種類
+----------------------
+
+バグの報告
+~~~~~~~~~~~
+
+もしバグを発見したらhttps://github.com/nidhaloff/deep_translator/issues でバクを報告してください。
+
+バグを報告する際にはトラブルシューティングしやすいように、以下の項目を含めて投稿するようにしてください。
+
+* バグの発生したOSの種類とOSバージョンの情報
+* ソフトウェアの設定などのローカル環境の情報
+* バグを再現するための詳細な手順
+
+バグの修正
+~~~~~~~~
+
+このリポジトリのイシューを見ることで、バグの情報を確認できます。
+"bug" と "help wanted"でタグ付けされているものは、誰でもバグを修正にしてコントリビュートすることができます。
+
+追加機能の実装
+~~~~~~~~~~~~~~~~~~
+
+このリポジトリのイシューを見ることで、実装待ちの機能が確認できます。
+"enhancement" と "help wanted"でタグ付けされているものは、誰でも実装してコントリビュートすることができます。
+
+ドキュメントの作成
+~~~~~~~~~~~~~~~~~~~
+
+deep_translator は、deep_translator の公式ドキュメントの一部、docstrings、あるいはウェブ上のブログ記事や記事など、常により多くのドキュメントを求めています。
+
+
+新しい機能の提案
+~~~~~~~~~~~~~~~
+
+新しい提案をするには https://github.com/nidhaloff/deep_translator/issues に投稿してください。
+
+新しい機能を提案するときには、以下の項目を留意してください:
+
+* 新しい機能の動作をできるだけ詳しく説明してください。 
+* 実装しやすいように機能の規模は限定するようにしてください。
+* このプロジェクトがボランティアから成り立っていることと、コントリビュートを歓迎する精神を忘れないでください。
+  
+
+開発環境の構築
+------------
+
+コントリビュートの準備はできましたか？ここからは deep_translator の開発環境を構築する方法について説明します。
+
+1. GitHub で deep_translator をフォークする.
+2. フォークしたものをローカルリポジトリとしてクローンする。::
+
+    $ git clone [email protected]:your_name_here/deep_translator.git
+
+3. virtualenvの作成とインストールを行う。virtualenvwrapperがインストール済みとすると、以下のコマンドでローカルに開発環境を構築できる::
+
+    $ mkvirtualenv deep_translator
+    $ cd deep_translator /
+    $ python setup.py develop
+
+4. ローカルで開発を行うために新しいブランチを作成する::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   これでローカルリポジトリに変更を加えることができるようになります。
+
+5. 変更が終わったらflake8のコードチェックとテストを通過するようにする。この時、toxで複数バージョンのPythonで動作することを確認する::
+
+    $ flake8 deep_translator tests
+    $ python setup.py test or pytest
+    $ tox
+
+　　flake8とtoxのインストールは、virtualenvでpip installを行うことで可能です。
+
+6. 変更をコミットし、自分のリモートリポジトリにプッシュする::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. GitHub からプルリクエストを送る.
+
+プルリクエストにあたって
+-----------------------
+
+プルリクエストを送る前に以下のガイドラインに従っているか確認してください:
+
+1. プルリクエストにテストが含まれている。
+
+2. プルリクエストで機能が追加された場合、ドキュメントを更新する必要があります。新しい機能について関数内にdocstringで記述し、それに加えてリストREADME.rstのリストに追加してください。
+
+3. プルリクエストによる変更はPython 3.5、3.6、3.7、3.8またはPyPyで動作することが望まれます。https://travisci.com/nidhaloff/deep_translator/pull_requests　を確認し、サポートされている全てのPythonバージョンでテストを通過することを確認してください。
+
+
+ヒント
+----
+
+テストのサブセットを実行するには以下のコマンドが利用できます::
+
+$ pytest tests.test_deep_translator
+
+
+デプロイの方法
+---------
+
+メンテナンス担当者のためにデプロイの方法を記しておきます。まず、全ての変更がコミットされていることを確認してください。(HISTORY.rstのエントリを含む).
+次に、以下のコマンドを実行します::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travisはテストを通過することを確認したら、PyPIにデプロイします。

ja/README.rst

@@ -0,0 +1,347 @@
+****************
+deep_translator
+****************
+
+
+.. 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://travis-ci.com/nidhaloff/deep_translator
+.. 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/dm/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://img.shields.io/pypi/wheel/deep-translator
+        :target: https://pypi.python.org/pypi/deep_translator
+
+.. image:: https://img.shields.io/github/last-commit/nidhaloff/gpx_converter
+        :alt: GitHub last commit
+        :target: https://pypi.python.org/pypi/deep_translator
+
+.. image:: https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FNidhalBaccouri
+        :alt: Twitter URL
+        :target: https://twitter.com/NidhalBaccouri
+
+.. image:: https://img.shields.io/badge/$-buy%20me%20a%20coffee-ff69b4.svg?style=social
+   :target: https://www.buymeacoffee.com/nidhaloff?new=1
+
+
+=======================
+自然言語の翻訳ツール
+=======================
+
+複数の翻訳サービスを使って、簡単な方法で異なる言語間で柔軟に翻訳を **無料** かつ **無制限** に行えるツールです
+
+* フリーソフトウェア: MIT ライセンス
+* ドキュメント: https://deep-translator.readthedocs.io.
+
+==========
+開発の動機
+==========
+
+Pythonを使用してテキストを別の言語に翻訳するタスクがありました。しかし、それを行う簡単な方法を見つけるのは困難でした。なぜなら、このタスクに適用できるライブラリはいくつか存在しますが、それらのほとんどはバグが多いか、無料ではないか、何らかの制約があるか、全ての言語をサポートしていないか、使用するのが簡単ではありませんでした。
+
+そこで、このタスクを簡単に行えるツールを作成することにしました。100％無料で無制限で使いやすく、すべての言語をサポートしています。
+
+このツールの目的は、複数の有名な翻訳サービスをこのツールに統合することにあります。
+
+
+======================
+使用例
+======================
+
+- Pythonを使用してテキストを翻訳したい場合
+- ファイルのテキストを翻訳したい場合
+- 1つだけでなく、多くのソースから翻訳結果を取得したい場合
+- 翻訳を自動化したい場合
+- 異なる翻訳結果を比較したい場合
+- 言語を自動検出したい場合
+
+======================
+このツールの強み
+======================
+
+- 高度な抽象化が施されている
+- 言語を自動で検出する
+- 拡張と使用が簡単である
+- 多くの翻訳サービスを統合して扱える唯一のpythonツールである
+- 安定している
+- 有名な翻訳サービスをサポートしている
+
+========
+機能
+========
+
+* google翻訳のサポート
+* Pons  (pons.com)のサポート
+* Linguee のサポート
+* Mymemory のサポート
+* 自動言語検出
+* テキストファイルから直接翻訳する
+* 単語の複数の翻訳結果を取得する
+* 異なる言語の異なる段落の翻訳を自動化する
+* コマンドラインから直接翻訳する（バージョン1.1.0以上）
+
+=============
+インストール方法
+=============
+
+ツールの安定版をインストールする方法です:
+
+.. code-block:: console
+
+    $ pip install -U deep_translator
+
+ソースからインストールを行いたい場合、ドキュメントを参照してください。
+
+=====
+使い方
+=====
+
+このセクションでは、このツールで様々な統合トランスレータを利用するデモを行います。このデモでは、google、pons、linguee、mymemoryの翻訳サービスを扱います（現時点）。将来的には、より多くの翻訳サービスを統合する予定です。
+
+インポート
+========
+
+.. code-block:: python
+
+    from deep_translator import (GoogleTranslator,
+                                 PonsTranslator,
+                                 LingueeTranslator,
+                                 MyMemoryTranslator,
+                                 detect_language)
+
+
+サポートされている言語を確認する
+==========================
+
+ポイント
+
+  　関数get_supported_languagesを静的メソッドとして呼び出すことにより、各翻訳サービスでサポートしている言語を確認できます。
+
+.. code-block:: python
+
+    # デフォルトではリストを返します
+    langs_list = GoogleTranslator.get_supported_languages()  # output: [arabic, french, english etc...]
+
+    # 言語の省略形を辞書型にまとめて返すことも出来ます
+    langs_dict = GoogleTranslator.get_supported_languages(as_dict=True)  # output: {arabic: ar, french: fr, english:en etc...}
+
+言語検出
+===================
+
+ポイント
+
+言語を自動的に検出することもできます。当然、このパッケージは無料です。言語検出機能を無料で使用する場合は、個人でapi_keyを取得する必要があります。ここで無料で入手することができます:https://detectlanguage.com/documentation
+
+.. code-block:: python
+
+    lang = detect_language('bonjour la vie', api_key='your_api_key')
+    print(lang) # output: fr
+
+
+Google 翻訳
+=================
+
+.. code-block:: python
+
+    text = 'happy coding'
+
+- ソースの言語に自動検出を使用できます:
+
+.. code-block:: python
+
+    translated = GoogleTranslator(source='auto', target='german').translate(text=text)
+
+- ソースの言語の種類を指定することも出来ます:
+
+.. code-block:: python
+
+    translated = GoogleTranslator(source='english', target='german').translate(text=text)
+
+- 言語名は省略形で指定することも可能です:
+
+.. code-block:: python
+
+    translated = GoogleTranslator(source='en', target='de').translate(text=text)
+
+- ファイルから翻訳を行うことも出来ます:
+
+.. code-block:: python
+
+    translated = GoogleTranslator(source='auto', target='german').translate_file('path/to/file')
+
+
+- ソースの言語を検出し、望んだ言語に自動翻訳することが出来ます。
+
+.. code-block:: python
+
+    # または、異なる言語の文章の翻訳を自動化したい時にも利用できます。
+    translated = GoogleTranslator(source='auto', target='de').translate_sentences([your_list_of_sentences])
+
+
+
+
+PONS
+===============
+
+ポイント
+
+Google翻訳同様に言語の名前を指定して翻訳することが出来ます。省略形で指定することも可能です。
+
+.. code-block:: python
+
+    word = 'awesome'
+
+- 簡単な翻訳方法
+
+.. code-block:: python
+
+    translated_word = PonsTranslator(source='english', target='french').translate(word)
+
+    # 言語の省略形を指定する
+    translated_word = PonsTranslator(source='en', target='fr').translate(word)
+
+
+- 全ての同義語か一致する単語を返す
+
+.. code-block:: python
+
+    # 翻訳結果の全ての同義語を取得したい場合、引数にreturn_allにTrueを指定してください
+    translated_word = LingueeTranslator(source='english', target='french').translate(word, return_all=True)
+
+
+
+Linguee
+===================
+
+
+.. code-block:: python
+
+    word = 'good'
+
+- 簡単な翻訳方法
+
+.. code-block:: python
+
+    translated_word = LingueeTranslator(source='english', target='french').translate(word)
+
+    # 言語の省略形を指定する
+    translated_word = LingueeTranslator(source='en', target='fr').translate(word)
+
+- 全ての同義語か一致する単語を返す
+
+.. code-block:: python
+
+    # 翻訳結果の全ての同義語を取得したい場合、引数にreturn_allにTrueを指定してください
+    translated_word = LingueeTranslator(source='english', target='french').translate(word, return_all=True)
+
+
+Mymemory
+====================
+
+ポイント
+
+sourceに"auto"を渡すことでmymemoryの自動言語検出を使用できます。
+
+.. code-block:: python
+
+    text = 'Keep it up. You are awesome'
+
+    translated = MyMemoryTranslator(source='auto', target='french').translate(text)
+
+ターミナルでの使用方法
+====================
+
+
+ターミナルからdeep_translatorをすぐに使用できます。使用するには、使用する翻訳サービス、翻訳元の言語、翻訳先の言語、翻訳するテキストなどを引数に指定する必要があります。
+たとえば、Google翻訳を使用するには、引数として「google」を指定します。引数を変更することで、サポートされている他の翻訳サービスに切り替えることも可能です。ドキュメントを読んで、このツールでサポートされている翻訳サービスを確認してください。
+
+
+.. code-block:: console
+
+    $ deep_translator --translator "google" --source "english" --target "german" --text "happy coding"
+
+以下のように短く記述することもできます:
+
+.. code-block:: console
+
+    $ deep_translator -trans "google" -src "english" -tg "german" -txt "happy coding"
+
+
+翻訳元と翻訳先の言語を省略形で引数に指定することも出来ます。
+
+.. code-block:: console
+
+    $ deep_translator -trans "google" -src "en" -tg "de" -txt "happy coding"
+
+
+ヒント
+==========
+
+一般的に、google翻訳とmymemoryは文章に翻訳に適していますが、ponsとlingueeは単語の翻訳に適しています。
+
+========
+リンク
+========
+
+deep_translatorの使用目的やpythonで翻訳をする方法を確認するために以下のmediumの記事を確認してください。
+https://medium.com/@nidhalbacc/how-to-translate-text-with-python-9d203139dcf5
+
+===========================
+スマートフォンアプリ Translator++ 
+===========================
+
+.. image:: assets/app-icon.png
+    :width: 100
+    :alt: Icon of the app
+
+
+deep_translatorを開発しみて、スマートフォンのアプリとして使用できれば便利なのではないかと思い立ちました。
+google翻訳やpons、lingueeの個々のアプリは存在しますが、これらを統合して使用できるアプリを作れば便利ではないでしょうか。
+
+それを出発点として、アプリの開発を開始しました。Pythonで作成しつつ、クロスプラットフォームのアプリを開発したかったので、`kivy フレームワーク <https://kivy.org/#home/>`_ を使用することにしました。
+`Translator++ app <https://github.com/nidhaloff/deep-translator-app/>`_ もgithubでオープンソースとして公開しています。自由に編集やプルリクエストを行ってください;）
+
+ポイント
+
+Translator++はdeep_translatorパッケージがベースになっています。このアプリはパッケージの機能を試すために開発されています。
+
+02-08-2020にGoogle Playで初公開されました。
+
+スクリーンショット:
+
+- スマートフォン :
+
+.. 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
+
+- タブレット:
+
+.. image:: assets/hz_view.png
+    :width: 100%
+    :height: 300
+    :alt: screenshot3
+
+==========
+次のステップに進むためには
+==========
+
+詳細は examples フォルダを確認してください。
+コントリビュートはいつでも歓迎しています。このパッケージが便利だと感じた方や使っている方がいたら、遠慮なくプルリクエストをしてフィードバックをください！

ja/index.rst

@@ -0,0 +1,20 @@
+deep_translatorのドキュメントへようこそ！
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   readme
+   installation
+   usage
+   modules
+   contributing
+   authors
+   history
+
+目次
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

ja/installation.rst

@@ -0,0 +1,50 @@
+.. highlight:: shell
+
+============
+インストール方法
+============
+
+
+安定版
+--------------
+
+deep_translatorをインストールしたい場合、以下のコマンドをターミナルで入力してください:
+
+.. code-block:: console
+
+    $ pip install deep_translator
+
+常に最新の安定版をインストールできるため、deep_translatorはこの方法でインストールすることを推奨します。
+
+pipがインストールされていない場合は、以下のPythonインストールガイドを参照してください。
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+From sources
+------------
+
+deep_translatorのソースはGithubのリポジトリからダウンロードできます.
+
+公開されているリポジトリのクローンも可能です:
+
+.. code-block:: console
+
+    $ git clone git://github.com/nidhaloff/deep_translator
+
+tarballをインストールする場合は以下のようになります:
+
+.. code-block:: console
+
+    $ curl -OJL https://github.com/nidhaloff/deep_translator/tarball/master
+
+クローンした後に、以下のコマンドを実行することでインストールが出来ます:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+
+.. _Github repo: https://github.com/nidhaloff/deep_translator
+.. _tarball: https://github.com/nidhaloff/deep_translator/tarball/master

ja/usage.rst

@@ -0,0 +1,75 @@
+=====
+使い方
+=====
+
+.. code-block:: python
+
+    from deep_translator import GoogleTranslator, PonsTranslator, LingueeTranslator, MyMemoryTranslator
+
+    english_text = 'happy coding'
+
+    result_german = GoogleTranslator(source='auto', target='de').translate(text=english_text)
+
+    # 言語を名前で指定することもできます:
+    translated = GoogleTranslator(source='english', target='german').translate(text=english_text)
+
+    # テキストファイルを翻訳したい場合
+    translated = GoogleTranslator(source='auto', target='german').translate_file('path/to/file')
+
+    # 複数の言語の文章の翻訳を自動化したい場合
+    translated = GoogleTranslator(source='auto', target='de').translate_sentences(your_list_of_sentences)
+
+
+Ponsを利用することも出来ます: Pons.com
+
+
+.. code-block:: python
+
+    word = 'good'
+    translated_word = PonsTranslator(source='english', target='french').translate(word)
+
+    # 翻訳する単語の同義語を全て取得したい場合は、return_allにTrueを指定してください。
+    translated_word = PonsTranslator(source='english', target='french').translate(word, return_all=True)
+
+
+deep_translatorのバージョン1.0.0以上でLingueeをサポートしています:
+
+
+.. code-block:: python
+
+    word = 'good'
+    translated_word = LingueeTranslator(source='english', target='french').translate(word)
+
+    # 翻訳する単語の同義語を全て取得したい場合は、return_allにTrueを指定してください。
+    translated_word = LingueeTranslator(source='english', target='french').translate(word, return_all=True)
+
+
+Mymemoryはバージョン1.0.2以上でサポートされています:
+
+.. code-block:: python
+
+    word = 'good'
+    translated_word = MyMemoryTranslator(source='english', target='french').translate(word)
+
+
+ターミナルでの使用方法
+====================
+
+ターミナルからdeep_translatorをすぐに使用できます。使用するには、使用する翻訳サービス、翻訳元の言語、翻訳先の言語、翻訳するテキストなどを引数に指定する必要があります。
+たとえば、Google翻訳を使用するには、引数として「google」を指定します。引数を変更することで、サポートされている他の翻訳サービスに切り替えることも可能です。ドキュメントを読んで、このツールでサポートされている翻訳サービスを確認してください。
+
+.. code-block:: console
+
+    $ deep_translator --translator "google" --source "english" --target "german" --text "happy coding"
+
+以下のように短く記述することもできます:
+
+.. code-block:: console
+
+    $ deep_translator -trans "google" -src "english" -tg "german" -txt "happy coding"
+
+翻訳元と翻訳先の言語を省略形で引数に指定することも出来ます。
+
+.. code-block:: console
+
+    $ deep_translator -trans "google" -src "en" -tg "de" -txt "happy coding"