Merge pull request #9 from speechmatics/examples/client_side_function_calling

Add client-side function calling example and docs update

Author: dumitrugutu

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [0.0.7] - 2024-11-25
+
+### Added
+
+- Client-side function calling example
+- Improved audio playback in examples
+- Added instructions on how to generate an API KEY and how to install pyaudio
+
+### Changed
+
+- Set default URL when running from CLI
+
 ## [0.0.6] - 2024-11-18
 
 ### Added

README.md

@@ -23,22 +23,25 @@ Windows users may need to run the install command with an extra flag:
 python setup.py install --user
 ```
 
+Instructions on how to create an account and generate an API
+key can be found here: https://docs.speechmatics.com/flow/getting-started#set-up
+
 ## Example command-line usage
 
 - Setting URLs for connecting to flow service. These values can be used in places of the --url flag:
 
 *Note: Requires access to microphone
 
  ```bash
- speechmatics-flow --url $URL --auth-token $TOKEN --ssl-mode insecure
+ speechmatics-flow --auth-token $TOKEN --ssl-mode insecure
  ```
 
 ### Change Assistant (Amelia → Humphrey)
 
 To set the assistant to *Humphrey* instead of *Amelia* run this command:
 
 ```bash
-speechmatics-flow --url $URL --auth-token $TOKEN --ssl-mode insecure --assistant humphrey
+speechmatics-flow --auth-token $TOKEN --ssl-mode insecure --assistant humphrey
 ```
 
 ### Load conversation_config from a config file
@@ -60,7 +63,7 @@ using the `--config-file` option
 ```
 
  ```bash
- speechmatics-flow --url $URL --auth-token $TOKEN --ssl-mode insecure --config-file conversation_config.json
+ speechmatics-flow --auth-token $TOKEN --ssl-mode insecure --config-file conversation_config.json
  ```
 
 > **Hint**: Why limit Humphrey? Try changing the template_variables to see what happens if he’s not a butler but

VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

examples/README.md

@@ -0,0 +1,43 @@
+# Examples using Flow API
+
+## Installation
+
+The Speechmatics Flow library and CLI can be installed using pip:
+
+```bash
+pip3 install speechmatics-flow
+```
+
+## Prerequisites
+
+### Generate an API Key
+
+Instructions on how to create an account and generate an API
+key can be found here: https://docs.speechmatics.com/flow/getting-started#set-up
+
+Set the API Key environment variable required to run the examples:
+
+```bash
+export SPEECHMATICS_API_KEY=$API_KEY
+```
+
+To use this script, you may also need to install PyAudio by running:
+
+### Windows
+
+```bash
+python -m pip install pyaudio
+```
+
+### macOS
+
+```bash
+brew instal portaudio
+pip3 install pyaudio
+```
+
+### GNU/Linux
+
+```bash
+sudo apt install python3-pyaudio
+```