ankiazvox 0.2.0

A CLI tool to synchronize Anki notes with high-quality Azure TTS audio.

ankiazvox

ankiazvox is a professional CLI tool designed to synchronize Anki notes with high-quality neural audio powered by Azure Cognitive Services. It automates the process of fetching text, generating speech, and updating your Anki cards.

✨ Features

• Neural TTS: Uses Azure's state-of-the-art Neural voices for natural, human-like speech.
• Seamless Integration: Automatically uploads audio to Anki's media folder and updates the [sound:...] tags via AnkiConnect.
• Batch Processing: Efficiently processes multiple notes using a single query.
• Flexible CLI: Built with Click for a smooth command-line experience with support for subcommands.
• Voice Explorer: Built-in command to list and filter available Azure voices.
• Smart Querying: Supports the full range of Anki's search syntax.

🚀 Installation

1. Prerequisites

• Anki Desktop with the AnkiConnect add-on installed.
• An Azure Speech Service subscription (Key and Region).

2. Install via pip (Recommended)

The easiest way to get started is to install directly from PyPI:

pip install ankiazvox

3. Install from Source (For Developers)

If you want to contribute or use the latest development version:

git clone \[https://github.com/ericxu131/ankiazvox.git\](https://github.com/ericxu131/ankiazvox.git)  
cd ankiazvox  
pip install .

⚙️ Configuration

Create a .env file in your working directory with your credentials:

# AnkiConnect Settings  
ANKI_CONNECT_URL=http://127.0.0.1:8765

# Azure Speech Settings  
AZURE_SPEECH_KEY=your_azure_api_key  
AZURE_SPEECH_REGION=your_service_region (e.g., eastus)

# Default Voice Configuration  
DEFAULT_VOICE=en-US-AvaMultilingualNeural

🛠 Usage

Once installed, you can use the azv (alias) or ankiazvox command.

1. Synchronize Audio (sync)

Sync notes from a specific deck using default settings:

azv sync --query "deck:MyEnglishDeck" --source "Front" --target "AudioField"

Override the default voice and limit the number of notes for a test run:

azv sync -q "tag:new_words" -s "Word" -t "Pronunciation" -v "zh-CN-YunyangNeural" --limit 10

Option	Short	Description
--query	-q	Anki search query (e.g., deck:Default, tag:marked)
--source	-s	The field name containing the text to be synthesized
--target	-t	The field name where the [sound:...] tag will be stored
--voice	-v	Overrides the default Azure voice defined in .env
--limit		Max number of notes to process in this run
--temp-dir		Custom directory for temporary audio files
--env		Path to a specific .env file

2. List Voices (list-voices)

List all available Azure TTS voices:

azv list-voices

Filter voices by locale (e.g., Chinese or British English):

azv list-voices --locale zh-CN  
azv list-voices -l en-GB

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.

👤 Author

Eric Xu - [e-mail]

Project Link: https://github.com/ericxu131/ankiazvox