Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Virtual env inst #420

Merged
merged 12 commits into from
Jul 14, 2016
Merged
23 changes: 23 additions & 0 deletions speech/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@ See the
[Cloud Platform Auth Guide](https://cloud.google.com/docs/authentication#developer_workflow)
for more information.

### Install pip
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer you to consolidate these steps like the app engine flex readme. Feel free to link to virtualenv and pip, but there's no need to give explicit instructions on installation.


Install [pip][pip] if not already installed

### Install virtualenv

Install [virtualenv][virtualenv] if not already installed

### Create isolated Python environment

```
virtualenv ~/speechsamples
source ~/speechsamples/bin/activate
```

### Install the dependencies

The sample uses the [PyAudio][pyaudio] library to stream audio from your computer's microphone. PyAudio depends on [PortAudio][portaudio], which may need to be compiled when you install PyAudio. If you run into compilation issues that mention PortAudio, you may have to [install some dependencies][pyaudio-install].
Expand All @@ -57,6 +72,8 @@ The sample uses the [PyAudio][pyaudio] library to stream audio from your compute
[pyaudio]: https://people.csail.mit.edu/hubert/pyaudio/
[portaudio]: http://www.portaudio.com/
[pyaudio-install]: https://people.csail.mit.edu/hubert/pyaudio/#downloads
[pip]: https://pip.pypa.io/en/stable/installing/
[virtualenv]: https://virtualenv.pypa.io/en/stable/installation/

## Run the example

Expand Down Expand Up @@ -89,3 +106,9 @@ The sample uses the [PyAudio][pyaudio] library to stream audio from your compute
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).

### Deactivate virtualenv

```
deactivate
```