| Name | azure-voice-list JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A package to retrieve available voices from Azure Cognitive Services Speech SDK. |
| upload_time | 2024-09-27 05:00:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
azure
cognitive services
sdk
speech
voice
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Azure Voice List
`azure_voice_list` is a Python package that integrates with Azure Cognitive Services Speech SDK to retrieve available voices.
## Features
- Retrieve available voices from Azure Speech SDK
- Save voice attributes to a text file
- Execute as a command-line tool for quick access
- Use as a standalone Python script within your projects
## Installation
You can install `azure_voice_list` via [PyPI](https://pypi.org/) using `pip`:
```bash
pip install azure_voice_list
```
## Usage
### 1. Importing and Using in Python Scripts
You can easily integrate `azure_voice_list` into your Python projects by importing the necessary functions.
```python
from azure_voice_list import get_available_voices
# Set your Azure credentials
speech_key = "YOUR_AZURE_SPEECH_KEY"
service_region = "YOUR_AZURE_SERVICE_REGION"
voices = get_available_voices(speech_key, service_region)
if voices:
for voice in voices:
print(voice)
```
### 2. Executing as a Command-Line Tool
Running `azure_voice_list` as a command-line tool allows you to retrieve and save voice attributes without writing additional Python code.
#### a. Install the Package
You can install `azure_voice_list` via [PyPI](https://pypi.org/) using `pip`:
```bash
pip install azure_voice_list
```
#### b. Run the Command-Line Tool
Once installed, you can execute the tool from your terminal:
```bash
azure-voice-list
```
**Example Output:**
```
Voice attributes have been saved to 'output/voice_attributes_20230927_123456.txt'
```
#### c. Provide Azure Credentials
The command-line tool relies on environment variables for Azure credentials. Ensure you have a `.env` file in your project's root directory with the following content:
```env
AZURE_SPEECH_KEY=your_azure_speech_key
AZURE_SPEECH_REGION=your_azure_service_region
```
Alternatively, you can set these environment variables in your system.
### 3. Executing as a Standalone Python Script
If you prefer to run `azure_voice_list` without installing it as a package, you can execute the script directly using Python.
#### a. Clone the Repository
First, clone the repository to your local machine:
```bash
git clone https://github.com/BlueBirdBack/azure_voice_list.git
cd azure_voice_list
```
#### b. Install the Package
Install the package and its dependencies using `pip`:
```bash
pip install .
```
#### c. Run the Script
Execute the `main.py` script using Python:
```bash
azure-voice-list
```
**Example Output:**
```
Voice attributes have been saved to 'output/voice_attributes_20230927_123456.txt'
```
#### d. Provide Azure Credentials
Similar to the command-line tool, ensure that the `.env` file with your Azure credentials is present in the project root directory:
```env
AZURE_SPEECH_KEY=your_azure_speech_key
AZURE_SPEECH_REGION=your_azure_service_region
```
_Alternatively, set the environment variables in your system._
### Output Directory
By default, the `azure_voice_list` tool saves the voice attributes to an `output` directory located at the root of the project. If you encounter multiple `output` directories, ensure you're running the tool from the project root and verify the configuration in the script.
## License
[MIT](LICENSE)
## Additional Information
- **Homepage:** [https://github.com/BlueBirdBack/azure_voice_list](https://github.com/BlueBirdBack/azure_voice_list)
- **Repository:** [https://github.com/BlueBirdBack/azure_voice_list](https://github.com/BlueBirdBack/azure_voice_list)
Raw data
{
"_id": null,
"home_page": null,
"name": "azure-voice-list",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "BlueBirdBack <avery@bluebirdback.com>",
"keywords": "azure, cognitive services, sdk, speech, voice",
"author": null,
"author_email": "BlueBirdBack <avery@bluebirdback.com>",
"download_url": "https://files.pythonhosted.org/packages/ae/c9/a8fa7a78ae6dbd2af5ce5da3437648310b1c01d622d0d27e47ea06cb5841/azure_voice_list-0.1.0.tar.gz",
"platform": null,
"description": "# Azure Voice List \n\n`azure_voice_list` is a Python package that integrates with Azure Cognitive Services Speech SDK to retrieve available voices.\n\n## Features\n\n- Retrieve available voices from Azure Speech SDK\n- Save voice attributes to a text file\n- Execute as a command-line tool for quick access\n- Use as a standalone Python script within your projects\n\n## Installation\n\nYou can install `azure_voice_list` via [PyPI](https://pypi.org/) using `pip`:\n\n```bash\npip install azure_voice_list\n```\n\n## Usage\n\n### 1. Importing and Using in Python Scripts\n\nYou can easily integrate `azure_voice_list` into your Python projects by importing the necessary functions.\n\n```python\nfrom azure_voice_list import get_available_voices\n\n# Set your Azure credentials\nspeech_key = \"YOUR_AZURE_SPEECH_KEY\"\nservice_region = \"YOUR_AZURE_SERVICE_REGION\"\n\nvoices = get_available_voices(speech_key, service_region)\nif voices:\n for voice in voices:\n print(voice)\n```\n\n### 2. Executing as a Command-Line Tool\n\nRunning `azure_voice_list` as a command-line tool allows you to retrieve and save voice attributes without writing additional Python code.\n\n#### a. Install the Package\n\nYou can install `azure_voice_list` via [PyPI](https://pypi.org/) using `pip`:\n\n```bash\npip install azure_voice_list\n```\n\n#### b. Run the Command-Line Tool\n\nOnce installed, you can execute the tool from your terminal:\n\n```bash\nazure-voice-list\n```\n\n**Example Output:**\n\n```\nVoice attributes have been saved to 'output/voice_attributes_20230927_123456.txt'\n```\n\n#### c. Provide Azure Credentials\n\nThe command-line tool relies on environment variables for Azure credentials. Ensure you have a `.env` file in your project's root directory with the following content:\n\n```env\nAZURE_SPEECH_KEY=your_azure_speech_key\nAZURE_SPEECH_REGION=your_azure_service_region\n```\n\nAlternatively, you can set these environment variables in your system.\n\n### 3. Executing as a Standalone Python Script\n\nIf you prefer to run `azure_voice_list` without installing it as a package, you can execute the script directly using Python.\n\n#### a. Clone the Repository\n\nFirst, clone the repository to your local machine:\n\n```bash\ngit clone https://github.com/BlueBirdBack/azure_voice_list.git\ncd azure_voice_list\n```\n\n#### b. Install the Package\n\nInstall the package and its dependencies using `pip`:\n\n```bash\npip install .\n```\n\n#### c. Run the Script\n\nExecute the `main.py` script using Python:\n\n```bash\nazure-voice-list\n```\n\n**Example Output:**\n\n```\nVoice attributes have been saved to 'output/voice_attributes_20230927_123456.txt'\n```\n\n#### d. Provide Azure Credentials\n\nSimilar to the command-line tool, ensure that the `.env` file with your Azure credentials is present in the project root directory:\n\n```env\nAZURE_SPEECH_KEY=your_azure_speech_key\nAZURE_SPEECH_REGION=your_azure_service_region\n```\n\n_Alternatively, set the environment variables in your system._\n\n### Output Directory\n\nBy default, the `azure_voice_list` tool saves the voice attributes to an `output` directory located at the root of the project. If you encounter multiple `output` directories, ensure you're running the tool from the project root and verify the configuration in the script.\n\n## License\n\n[MIT](LICENSE)\n\n## Additional Information\n\n- **Homepage:** [https://github.com/BlueBirdBack/azure_voice_list](https://github.com/BlueBirdBack/azure_voice_list)\n- **Repository:** [https://github.com/BlueBirdBack/azure_voice_list](https://github.com/BlueBirdBack/azure_voice_list)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package to retrieve available voices from Azure Cognitive Services Speech SDK.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/BlueBirdBack/azure_voice_list",
"Repository": "https://github.com/BlueBirdBack/azure_voice_list"
},
"split_keywords": [
"azure",
" cognitive services",
" sdk",
" speech",
" voice"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d587c6767098952a7cf6df476f870dd03ea3ac65273d39c1bc0edaaeda85ee12",
"md5": "eece5d97dcd82c0cbf124e42ea4cd243",
"sha256": "94d4b9838b2e2ef3dd16f1150c6f2d4c619b33bf5c330c1a7fc1a00cf4b91a23"
},
"downloads": -1,
"filename": "azure_voice_list-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eece5d97dcd82c0cbf124e42ea4cd243",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5025,
"upload_time": "2024-09-27T05:00:04",
"upload_time_iso_8601": "2024-09-27T05:00:04.438524Z",
"url": "https://files.pythonhosted.org/packages/d5/87/c6767098952a7cf6df476f870dd03ea3ac65273d39c1bc0edaaeda85ee12/azure_voice_list-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aec9a8fa7a78ae6dbd2af5ce5da3437648310b1c01d622d0d27e47ea06cb5841",
"md5": "55b419d0d4015bcf992ca12987bd43e0",
"sha256": "6ed684e9beaed2f59e97392d719b77f9ef9bbc7053d39ac9f62b7c14599be804"
},
"downloads": -1,
"filename": "azure_voice_list-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "55b419d0d4015bcf992ca12987bd43e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5693,
"upload_time": "2024-09-27T05:00:06",
"upload_time_iso_8601": "2024-09-27T05:00:06.444521Z",
"url": "https://files.pythonhosted.org/packages/ae/c9/a8fa7a78ae6dbd2af5ce5da3437648310b1c01d622d0d27e47ea06cb5841/azure_voice_list-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 05:00:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlueBirdBack",
"github_project": "azure_voice_list",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "azure-voice-list"
}
