Skip to content

Commit

Permalink
chore: Improve project metadata and documentation.
Browse files Browse the repository at this point in the history
- Update project description in `setup.py`
- Remove unnecessary comments in `install_requires` in `setup.py`
- Remove a mermaid graph from README.md
- Clarify purpose of `max_tokens` setting in configuration
- Update example configuration file in README.md
  • Loading branch information
johnnyhuy committed Apr 7, 2024
1 parent 81add0c commit 18be3b8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 20 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,6 @@ The Transcribe Me application follows a straightforward workflow:
make install-cli
```

```mermaid
graph TD
A[Clone Repository] --> B[Install ASDF and Homebrew]
B --> C[Install Python and FFmpeg]
C --> D[Install Python Dependencies]
D --> E[Configure API Keys]
E --> F[Place Audio Files]
F --> G[Run Application]
A --> D
D --> E
E --> F
F --> G
```

## :wrench: Usage

1. Place your audio files in the `input` directory (or any other directory specified in the configuration).
Expand All @@ -104,6 +89,8 @@ graph TD

The application uses a configuration file (`.transcribe.yaml`) to specify settings such as input/output directories, API keys, models, and their configurations. The configuration file is created automatically when you run the `transcribe-me install` command.

> `max_tokens` is the maximum number of tokens to generate in the summary. The default is dynamic based on the model.
Here is an example configuration file:

```yaml
Expand All @@ -117,7 +104,6 @@ openai:
anthropic:
models:
- temperature: 0.8
max_tokens: 2048
model: claude-3-sonnet-20240229
system_prompt: Generate something creative and interesting, use Markdown, be a concise tech expert but kind to non-technical readers.

Expand Down
5 changes: 1 addition & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name='transcribe_me',
description='A tool for transcribing audio files using the OpenAI Whisper API.',
description='A CLI tool to transcribe audio files using OpenAI API',
version='0.1.0',
packages=find_packages(),
entry_points={
Expand All @@ -11,11 +11,8 @@
],
},
install_requires=[
# List your project's dependencies here
'openai',
'anthropic',
'pydub',
'tqdm',
# ...
],
)

0 comments on commit 18be3b8

Please sign in to comment.