Skip to content

Commit 0d0572f

Browse files
committed
Make README more clear and support poetry
1 parent 275684b commit 0d0572f

File tree

3 files changed

+1077
-4
lines changed

3 files changed

+1077
-4
lines changed

examples/voice/cli/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,17 @@ Install dependencies for this example:
1212
```shell
1313
cd examples/voice/cli
1414
uv sync
15+
# or
16+
poetry install
1517
```
1618

1719
For microphone support, install the `mic` dependency group. You may need to install
1820
a system package for `pyaudio` first (e.g. `portaudio19-dev` on Debian/Ubuntu, `portaudio` on MacOS):
1921

2022
```shell
2123
uv sync --group mic
24+
# or
25+
poetry install --with mic
2226
```
2327

2428
Define your DeepL Auth key as an environment variable `DEEPL_AUTH_KEY`.
@@ -30,19 +34,25 @@ export DEEPL_AUTH_KEY=your-api-key-here
3034
Translate an audio file to one or more target languages:
3135

3236
```shell
33-
python examples/voice/cli/deepl-voice-api-cli.py audio.mp3 de fr
37+
uv run python deepl-voice-api-cli.py audio.mp3 de fr
38+
# or
39+
poetry run python deepl-voice-api-cli.py audio.mp3 de fr
3440
```
3541

3642
For live microphone translation, use `-` as the audio file path:
3743

3844
```shell
39-
python examples/voice/cli/deepl-voice-api-cli.py - es
45+
uv run python deepl-voice-api-cli.py - es
46+
# or
47+
poetry run python deepl-voice-api-cli.py - es
4048
```
4149

4250
For an explanation of the command line arguments, provide the `--help` option:
4351

4452
```shell
45-
python examples/voice/cli/deepl-voice-api-cli.py --help
53+
uv run python deepl-voice-api-cli.py --help
54+
# or
55+
poetry run python deepl-voice-api-cli.py --help
4656
```
4757

4858
## How it works

0 commit comments

Comments
 (0)