docs: PyAudioWrapper.get_pyaudio()

Uberi · Nov 5, 2024 · affab62 · affab62
1 parent 87db628
commit affab62
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/speech_recognition/microphone.py b/speech_recognition/microphone.py
@@ -10,10 +10,16 @@
 class PyAudioWrapper:
     @staticmethod
     def get_pyaudio() -> pyaudio.PyAudio:
+        """Returns pyaudio.PyAudio instance.
+
+        Checks pyaudio's installation, throws exceptions if pyaudio can't be found
+        """
         try:
             import pyaudio
         except ImportError:
-            raise AttributeError("Could not find PyAudio; check installation")
+            raise AttributeError(
+                "Could not find PyAudio; Run `pip install SpeechRecognition[audio]`"
+            )
         return pyaudio.PyAudio()
 
     @staticmethod