Merge pull request #12 from speechpro/toml

Чтение credentials из TOML файла

Author: hiisi13

HISTORY.rst

@@ -2,6 +2,11 @@
 History
 =======
 
+0.1.9 (2020-08-29)
+------------------
+
+* Credentials can now be stored in TOML format and read automatically.
+
 0.1.8 (2020-08-28)
 ------------------
 

README.md

@@ -1,17 +1,20 @@
 # Распознавание и синтез речи в Облаке ЦРТ
+[![PyPI version](https://badge.fury.io/py/speechpro-cloud-python.svg)](https://badge.fury.io/py/speechpro-cloud-python)
 
 ## Начало работы
 Установите клиентскую библиотеку с помощью pip
-```
+```shell
 pip install speechpro-cloud-python
 ```
 
-Задайте данные вашей учетной записи [Облака ЦРТ](https://cp.speechpro.com) с помощью переменных среды, например
-```
-export SPEECHPRO_USERNAME=username
-export SPEECHPRO_DOMAIN_ID=200
-export SPEECHPRO_PASSWORD=password
+Создайте файл *~/.speechpro/credentials*, укажите в ней данные учетной записи в формате TOML в профиле (секции) *default*, например:
+```toml
+[default]
+username = "username"
+domain_id = 200
+password = "password"
 ```
+Узнайте больше об аутентификации в разделе [Аутентификация](#аутентификация).
 
 ## Распознавание речи из файла
 Код распознавания WAV файла на русском языке моделью **GENERAL** выглядит следующим образом
@@ -21,11 +24,7 @@ import os
 from speechpro.cloud.speech.recognition import RecognitionClient
 from speechpro.cloud.speech.recognition import enums
 
-сlient = RecognitionClient(
-    os.environ['SPEECHPRO_USERNAME'],
-    os.environ['SPEECHPRO_DOMAIN_ID'],
-    os.environ['SPEECHPRO_PASSWORD']
-)
+сlient = RecognitionClient()
 
 with open('path_to_wav_file', "rb") as f:
     content = f.read()
@@ -43,7 +42,7 @@ for w in word_list:
 ```
 
 Аналогичная операция с помощью командной строки
-```
+```shell
 speechpro recognize-word-list --model GENERAL --filename //path_to_audio
 ```
 
@@ -56,11 +55,7 @@ speechpro recognize-word-list --model GENERAL --filename //path_to_audio
 import os
 from speechpro.cloud.speech import synthesis
 
-сlient = synthesis.SynthesisClient(
-    os.environ['SPEECHPRO_USERNAME'],
-    os.environ['SPEECHPRO_DOMAIN_ID'],
-    os.environ['SPEECHPRO_PASSWORD']
-)
+сlient = synthesis.SynthesisClient()
 
 text = 'Привет, я - синтезированный голос от компании ЦРТ'
 audio = сlient.synthesize(synthesis.enums.Voice.JULIA, synthesis.enums.PlaybackProfile.SPEAKER, text)
@@ -70,13 +65,52 @@ with open('output.wav', 'wb') as f:
 ```
 
 Аналогичная операция с помощью командной строки
-```
+```shell
 speechpro synthesize --voice JULIA --input "Привет, я - синтезированный голос от компании ЦРТ" --output hi.wav
 ```
 
 ### Полная документация API синтеза речи
 Полная документация API синтеза речи доступна на сайте Облака ЦРТ по адресу https://cp.speechpro.com/doc/tts
 
+## Аутентификация
+
+Данные для аутентификации можно задать несколькими способами - передать в качестве параметров в конструктор, сохранить в TOML формате, либо установить переменные среды.
+
+### TOML
+
+Предполагается, что TOML файл расположен по пути *~/.speechpro/credentials*, по умолчанию используется профиль (секция) *default*:
+
+```toml
+[default]
+username = "username"
+domain_id = 200
+password = "password"
+```
+Для использования профиля с другим именем, установите его значение в переменную среду *SPEECHPRO_PROFILE*.
+
+### Переменные среды
+
+Задайте данные вашей учетной записи [Облака ЦРТ](https://cp.speechpro.com) с помощью переменных среды, их значения будут использованы в случае, если не удастся прочитать TOML файл.
+```shell
+export SPEECHPRO_USERNAME=username
+export SPEECHPRO_DOMAIN_ID=200
+export SPEECHPRO_PASSWORD=password
+```
+
+### Конструктор
+
+Возможно также передать значения напрямую в конструктор, например:
+
+```python
+from speechpro.cloud.speech.recognition import RecognitionClient
+
+сlient = RecognitionClient(
+    'username',
+    200,
+    'password'
+)
+```
+
 ## TODO
 * Добавить оставшиеся методы API распознавания речи
 * Описания моделей и голосов

requirements_dev.txt

@@ -8,3 +8,4 @@ coverage==4.5.4
 Sphinx==1.8.5
 twine==1.14.0
 Click==7.0
+toml==0.10.1

setup.py

@@ -16,7 +16,8 @@
     'six>=1.10',
     'python_dateutil>=2.5.3',
     'setuptools>=21.0.0',
-    'urllib3>=1.15.1'
+    'urllib3>=1.15.1',
+    'toml==0.10.1'
 ]
 
 setup_requirements = [ ]

speechpro/cli.py

@@ -7,17 +7,9 @@
 from speechpro.cloud.speech import synthesis
 
 
-recognitionClient = recognition.RecognitionClient(
-    os.environ['SPEECHPRO_USERNAME'],
-    os.environ['SPEECHPRO_DOMAIN_ID'],
-    os.environ['SPEECHPRO_PASSWORD']
-)
-
-synthesisClient = synthesis.SynthesisClient(
-    os.environ['SPEECHPRO_USERNAME'],
-    os.environ['SPEECHPRO_DOMAIN_ID'],
-    os.environ['SPEECHPRO_PASSWORD']
-)
+recognitionClient = recognition.RecognitionClient()
+
+synthesisClient = synthesis.SynthesisClient()
 
 
 def recognize(language, model, response_type, filename, audio_channel_count=1):

speechpro/cloud/speech/common/__init__.py

@@ -1,12 +1,30 @@
+from typing import Optional, Union
+import os
+
+import toml
 from speechpro.cloud.speech.common.rest.cloud_client.models.auth_status_dto import AuthStatusDto
 from speechpro.cloud.speech.common.rest.cloud_client import SessionApi, AuthRequestDto
 
 
 class SpeechproApiClientBase:
-    def __init__(self, username, domain_id, password):
-        self.username = username
-        self.domain_id = domain_id
-        self.password = password
+    def __init__(self, username: Optional[str] = None, domain_id: Optional[Union[str, int]] = None, password: Optional[str] = None):
+        if username and domain_id and password:
+            self.username = username
+            self.domain_id = domain_id
+            self.password = password
+        else:
+            profile: str = os.environ.get('SPEECHPRO_PROFILE', 'default')
+            try:
+                f = os.path.expanduser(os.path.join('~', '.speechpro', 'credentials'))
+                credentials = toml.load(f)[profile]
+                self.username = credentials['username']
+                self.domain_id = credentials['domain_id']
+                self.password = credentials['password']
+            except (FileNotFoundError, KeyError):
+                self.username = os.environ.get('SPEECHPRO_USERNAME')
+                self.domain_id = os.environ.get('SPEECHPRO_DOMAIN_ID')
+                self.password = os.environ.get('SPEECHPRO_PASSWORD')
+
         self._session_id = None
 
 
@@ -17,7 +35,7 @@ def _check_session_status(self) -> bool:
 
 
     @property
-    def session_id(self):
+    def session_id(self) -> str:
         if self._session_id and self._check_session_status():
             return self._session_id
         else: