Merge pull request #245 from GoogleCloudPlatform/speech-streaming

speechrest -> speech_rest, update README to include speech_streaming

Author: jerjou

speech/api/README.md

@@ -1,8 +1,9 @@
 
-# Google Cloud Speech API Sample (REST API)
+# Google Cloud Speech API Samples
 
-This example demos accessing the [Google Cloud Speech API](http://cloud.google.com/speech)
-via its REST API.
+These examples demo accessing the [Google Cloud Speech API](http://cloud.google.com/speech)
+in streaming mode (via its gRPC API) and in non-streaming mode (via its REST
+API).
 
 ## Prerequisites
 
@@ -30,19 +31,19 @@ downloaded service account credentials before running this example:
 
     export GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/credentials-key.json
 
-If you do not do this, you will see an error that looks something like this when
-you run the example script:
-`...<HttpError 403 when requesting https://speech.googleapis.com/v1/speech:recognize?alt=json returned "Request had insufficient authentication scopes.">`.
+If you do not do this, the REST api will return a 403. The streaming sample will
+just sort of hang silently.
+
 See the
 [Cloud Platform Auth Guide](https://cloud.google.com/docs/authentication#developer_workflow)
 for more information.
 
 ### Install the dependencies
 
-* If you're running the `speechrest.py` sample:
+* If you're running the `speech_rest.py` sample:
 
     ```sh
-    $ pip install requirements-speechrest.txt
+    $ pip install requirements-speech_rest.txt
     ```
 
 * If you're running the `speech_streaming.py` sample:
@@ -53,10 +54,10 @@ for more information.
 
 ## Run the example
 
-* To run the `speechrest.py` sample:
+* To run the `speech_rest.py` sample:
 
     ```sh
-    $ python speechrest.py resources/audio.raw
+    $ python speech_rest.py resources/audio.raw
     ```
 
     You should see a response with the transcription result.
@@ -70,3 +71,7 @@ for more information.
     The sample will run in a continuous loop, printing the data and metadata
     it receives from the Speech API, which includes alternative transcriptions
     of what it hears, and a confidence score. Say "exit" to exit the loop.
+
+    Note that the `speech_streaming.py` sample does not yet support python 3, as
+    the upstream `grpcio` library's support is [not yet
+    complete](https://github.com/grpc/grpc/issues/282).

speech/api/requirements-speechrest.txt renamed to speech/api/requirements-speech_rest.txt

@@ -13,7 +13,7 @@
 
 import re
 
-from speechrest import main
+from speech_rest import main
 
 
 def test_main(resource, capsys):

speech/api/speechrest.py renamed to speech/api/speech_rest.py

@@ -53,6 +53,7 @@ def mock_audio_stream(channels, rate, chunk):
     return mock_audio_stream
 
 
+# grpc doesn't yet support python3 https://github.com/grpc/grpc/issues/282
 @pytest.mark.skipif(
     sys.version_info >= (3, 0), reason="can't get grpc lib to work in python3")
 def test_main(resource, monkeypatch, capsys):