Skip to content

Commit ad92c29

Browse files
proppyproppy
committed
add top level README
1 parent 336b01b commit ad92c29

20 files changed

+298
-24
lines changed

‎README.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Google Assistant SDK for Python
2+
3+
This repositories contains the [Python][python] packages for [Google Assistant SDK][google-assistant-sdk].
4+
5+
## Contents
6+
7+
- [Google Assistant gRPC API bindings for Python](google-assistant-grpc): autogenerated Python bindings to communicate with the [Google Assistant gRPC API][google-assistant-api].
8+
- [Google Assistant SDK](google-assistant-sdk): tools and python samples to help developers get started with the [Google Assistant SDK][google-assistant-sdk].
9+
- [Google Assistant gRPC samples](google-assistant-sdk/googlesamples/assistant/grpc): reference sample for the [Google Assistant gRPC API][google-assistant-api].
10+
11+
## Contributing
12+
13+
Contributions to this repository are always welcome and highly encouraged.
14+
15+
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to get started.
16+
17+
## License
18+
19+
Copyright (C) 2017 Google Inc.
20+
21+
Licensed to the Apache Software Foundation (ASF) under one or more contributor
22+
license agreements. See the NOTICE file distributed with this work for
23+
additional information regarding copyright ownership. The ASF licenses this
24+
file to you under the Apache License, Version 2.0 (the "License"); you may not
25+
use this file except in compliance with the License. You may obtain a copy of
26+
the License at
27+
28+
http://www.apache.org/licenses/LICENSE-2.0
29+
30+
Unless required by applicable law or agreed to in writing, software
31+
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
32+
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
33+
License for the specific language governing permissions and limitations under
34+
the License.
35+
36+
[python]: https://www.python.org
37+
[google-assistant-api]: https://developers.google.com/assistant/sdk/reference/rpc
38+
[google-assistant-sdk]: https://developer.google.com/assistant/sdk

‎google-assistant-grpc/README.rst

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
Google Assistant gRPC API bindings for Python
2-
=============================================
1+
Google Assistant gRPC API bindings
2+
==================================
33

4-
This package contains the generated Python bindings for the `Google Assistant gRPC API <https://developers.google.com/assistant/sdk/reference/rpc/>`_.
4+
This package contains the generated Python_ bindings for the `Google Assistant gRPC API`_.
55

6-
It is part of the `Google Assistant SDK <https://developers.google.com/assistant/sdk>`_.
6+
It is part of the `Google Assistant SDK`_.
77

8-
It should be compatible with any POSIX platform with Python.
8+
It should be compatible with POSIX platform supporting gRPC_ and Python_.
9+
10+
.. _Python: https://www.python.org/
11+
.. _gRPC: https://www.grpc.io
12+
.. _Google Assistant gRPC API: https://developers.google.com/assistant/sdk/reference/rpc/
13+
.. _Google Assistant SDK: https://developers.google.com/assistant/sdk
914

1015
Installing
1116
----------

‎CHANGELOG.rst ‎google-assistant-sdk/CHANGELOG.rst

File renamed without changes.

‎google-assistant-sdk/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2014 The Android Open Source Project
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎MAINTAINER.md ‎google-assistant-sdk/MAINTAINER.md

File renamed without changes.

‎MANIFEST.in ‎google-assistant-sdk/MANIFEST.in

File renamed without changes.

‎README.rst ‎google-assistant-sdk/README.rst

+34-13
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Google Assistant SDK for Python
1+
Google Assistant SDK
22
===============================
33

4-
This package contains a collection of samples and tools to help you get started with the `Google Assistant SDK`_ using `Python`_.
4+
This package contains a collection of samples and tools to help you
5+
get started with the `Google Assistant SDK`_ using `Python`_.
56

67
Installing
78
----------
@@ -10,32 +11,51 @@ Installing
1011

1112
pip install --upgrade google-assistant-grpc
1213
13-
Authorization
14-
-------------
14+
Usage
15+
-----
16+
17+
google-oauthlib-tool
18+
~~~~~~~~~~~~~~~~~~~~
19+
20+
This tool creates test credentials to authorize devices to call the
21+
Google Assistant API when prototyping.
1522

1623
- `Follow the steps <https://developers.google.com/assistant/sdk/prototype/getting-started-other-platforms/config-dev-project-and-account>`_ to configure a Google API Console Project and a Google Account to use with the Google Assistant SDK.
1724

18-
- Download the ``client_secret_XXXXX.json`` file from the `Google API Console Project credentials section <https://console.developers.google.com/apis/credentials>`_ and generate credentials using ``google-oauth-tool``.::
25+
- Download the ``client_secret_XXXXX.json`` file from the `Google API Console Project credentials section <https://console.developers.google.com/apis/credentials>`_ and generate credentials.::
1926

2027
pip install --upgrade google-auth-oauthlib[tool]
2128
google-oauthlib-tool --client-secrets path/to/client_secret_XXXXX.json --scope https://www.googleapis.com/auth/assistant-sdk-prototype --save
2229

23-
Run the Samples
24-
---------------
30+
googlesamples-assistant-audiotest
31+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32+
33+
This tool verifies device setup for audio recording and playback.
34+
35+
- Record 10 seconds of audio samples and play them back.::
36+
37+
googlesamples-assistant-audiotest --duration 10
38+
39+
- Adjust the sound device block size and flush size for soundcard with limited throughput.::
40+
41+
googlesamples-assistant-audiotest --duration 10 --audio-block-size=3200 --audio-flush-size=6400
2542

26-
- Install the samples dependencies.
43+
The same ``--audio-block-size`` and ``--audio-flush-size`` options can
44+
be used on the ``gRPC`` samples included in the SDK.
2745

28-
- Ubuntu/Debian GNU/Linux::
46+
googlesamples-assistant-pushtotalk
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2948

30-
sudo apt-get install portaudio19-dev libffi-dev libssl-dev
49+
This reference sample implements a simple but functional client for the `Google Assistant gRPC API`_.
3150

32-
- Install the samples package using `pip`_::
51+
- Install the samples dependencies.::
3352

53+
sudo apt-get install portaudio19-dev libffi-dev libssl-dev
3454
pip install --upgrade google-assistant-sdk[samples]
3555

36-
- Try the `push to talk sample <googlesamples/assistant/grpc>`_:
56+
- Try the push to talk sample.::
3757

38-
python -m googlesamples.assistant.grpc.pushtotalk
58+
googlesamples-assistant-pushtotalk
3959

4060

4161
For Maintainers
@@ -74,3 +94,4 @@ the License.
7494
.. _Python: https://python.org/
7595
.. _pip: https://pip.pypa.io/
7696
.. _Google Assistant SDK: https://developers.google.com/assistant/sdk
97+
.. _Google Assistant gRPC API: https://developers.google.com/assistant/sdk/reference/rpc

‎googlesamples/__init__.py ‎google-assistant-sdk/googlesamples/__init__.py

File renamed without changes.

‎googlesamples/assistant/__init__.py ‎google-assistant-sdk/googlesamples/assistant/__init__.py

File renamed without changes.

‎googlesamples/assistant/grpc/README.rst ‎google-assistant-sdk/googlesamples/assistant/grpc/README.rst

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
Python samples for the Google Assistant gRPC API
22
================================================
33

4-
This repository contains reference samples for the ``google-assistant-grpc`` Python package.
4+
This repository contains a reference sample for the ``google-assistant-grpc`` Python package.
5+
6+
It implements the following features:
7+
- Trigger conversation using a key press.
8+
- Audio recording of user query.
9+
- Playback of assistant answer.
10+
- Conversation State management.
11+
- Volume control.
512

613
Prerequisites
714
-------------
@@ -52,11 +59,11 @@ Run the sample
5259
# Record a 5 sec sample and play it back
5360
python -m audio_helpers
5461

55-
- Record a voice query and the program should play back the Google Assistant's answer::
62+
- Record a voice query after a key press and the sample should play back the Google Assistant's answer::
5663

5764
python -m pushtotalk
5865

59-
- Record and send pre-recorded audio to the Assistant::
66+
- Record and send pre-recorded audio to the Assistant::
6067

6168
python -m pushtotalk -i in.wav
6269

‎googlesamples/assistant/grpc/__init__.py ‎google-assistant-sdk/googlesamples/assistant/grpc/__init__.py

File renamed without changes.

‎googlesamples/assistant/grpc/assistant_helpers.py ‎google-assistant-sdk/googlesamples/assistant/grpc/assistant_helpers.py

File renamed without changes.

‎googlesamples/assistant/grpc/audio_helpers.py ‎google-assistant-sdk/googlesamples/assistant/grpc/audio_helpers.py

File renamed without changes.

‎googlesamples/assistant/grpc/pushtotalk.py ‎google-assistant-sdk/googlesamples/assistant/grpc/pushtotalk.py

File renamed without changes.

‎googlesamples/assistant/grpc/requirements.txt ‎google-assistant-sdk/googlesamples/assistant/grpc/requirements.txt

File renamed without changes.

‎nox.py ‎google-assistant-sdk/nox.py

File renamed without changes.

‎setup.cfg ‎google-assistant-sdk/setup.cfg

File renamed without changes.

‎setup.py ‎google-assistant-sdk/setup.py

+5-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def samples_requirements():
3030
for p in samples_packages:
3131
with io.open(os.path.join('googlesamples', 'assistant', p,
3232
'requirements.txt')) as f:
33-
for p in f.readlines():
33+
for p in f:
3434
yield p.strip()
3535

3636

@@ -56,8 +56,10 @@ def samples_requirements():
5656
},
5757
entry_points={
5858
'console_scripts': [
59-
'googlesamples-assistant'
60-
'=googlesamples.assistant.__main__:main [samples]',
59+
'googlesamples-assistant-audiotest'
60+
'=googlesamples.assistant.grpc.audio_helpers:main',
61+
'googlesamples-assistant-pushtotalk'
62+
'=googlesamples.assistant.grpc.pushtotalk:main [samples]',
6163
],
6264
},
6365
license='Apache 2.0',

‎tests/data/whattimeisit.riff ‎google-assistant-sdk/tests/data/whattimeisit.riff

File renamed without changes.

‎tests/test_audio_helpers.py ‎google-assistant-sdk/tests/test_audio_helpers.py

File renamed without changes.

0 commit comments

Comments
 (0)