Skip to content

Commit 3148730

Browse files
committed
better messages + README
1 parent 1e857d5 commit 3148730

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,25 @@ Usage: [OPTIONS]
2222
Generate a transcription from an audio file. translate (str): Generate a
2323
translated transcription from an audio file. image (str): Generate an
2424
image from a prompt. number_of_images (int): Specify the number of
25-
images to generate. (default: 1) size (str): Specify the size of the
26-
images to generate (default: 1024x1024).
25+
images to generate. (default: 1) image_folder (str): Folder to save the
26+
generated images. size (str): Specify the size of the images to generate
27+
(default: 1024x1024).
2728

2829
Options:
29-
-h, --help Prints the help message.
30-
-v, --verbose Makes the error messages verbose.
31-
-c, --chat Start an interactive chat with the AI.
32-
-m, --model TEXT Model name to use for chat.
33-
-w, --whisper PATH Generate a transcription from an audio file.
34-
-t, --translate PATH Generate a translated transcription from an
35-
audio file.
36-
-i, --image TEXT Generate an image from a prompt.
37-
--number_of_images INTEGER Generate image(s) from a prompt. Specify the
38-
number of images to generate.
39-
--size TEXT Specify the size of the images to generate
40-
(default: 1024x1024).
30+
-h, --help Prints the help message.
31+
-v, --verbose Makes the error messages verbose.
32+
-c, --chat Start an interactive chat with the AI.
33+
-m, --model TEXT Model name to use for chat.
34+
-w, --whisper PATH Generate a transcription from an audio file.
35+
-t, --translate PATH Generate a translated transcription from an
36+
audio file.
37+
-i, --image TEXT Generate an image from a prompt.
38+
-n, --number-of-images INTEGER Generate image(s) from a prompt. Specify the
39+
number of images to generate.
40+
-f, --image-folder TEXT Folder to save the generated images.
41+
(Default: ./images)
42+
--size TEXT Specify the size of the images to generate
43+
(default: 1024x1024).
4144
```
4245

4346
## Usage Examples

main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"-f",
4242
"--image-folder",
4343
default="./images",
44-
help="Folder to save the generated images.",
44+
help="Folder to save the generated images. (Default: ./images)",
4545
)
4646
@click.option(
4747
"--size",

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
click==8.0.1
2+
icecream==2.1.3
23
python-dotenv==0.19.1
34
openai>=0.27.8
45
requests==2.31.0

0 commit comments

Comments
 (0)