Add uvx usage instructions and package configuration #1
23
README.md
23
README.md
@@ -48,10 +48,31 @@ Download and use the Llama3 model:
|
|||||||
```bash
|
```bash
|
||||||
ollama pull llama3
|
ollama pull llama3
|
||||||
|
|
||||||
## Test the access:
|
# Test the access:
|
||||||
ollama run llama3 "tell me a joke"
|
ollama run llama3 "tell me a joke"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage with uvx (no installation required)
|
||||||
|
|
||||||
|
You can run this tool directly without cloning the repository using `uvx`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Summarize a YouTube video
|
||||||
|
uvx --from git+https://github.com/damienarnodo/audio-summary-with-local-LLM.git audio-summary --from-youtube <YouTube-Video-URL>
|
||||||
|
|
||||||
|
# Summarize a local audio file
|
||||||
|
uvx --from git+https://github.com/damienarnodo/audio-summary-with-local-LLM.git audio-summary --from-local <path-to-audio-file>
|
||||||
|
|
||||||
|
# Transcribe only (no summary)
|
||||||
|
uvx --from git+https://github.com/damienarnodo/audio-summary-with-local-LLM.git audio-summary --from-youtube <YouTube-Video-URL> --transcript-only
|
||||||
|
|
||||||
|
# Specify language and output file
|
||||||
|
uvx --from git+https://github.com/damienarnodo/audio-summary-with-local-LLM.git audio-summary --from-local <path-to-audio-file> --language fr --output my_summary.md
|
||||||
|
```
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> `uvx` automatically creates a temporary virtual environment and installs all dependencies. On first run, this may take a moment. Ensure `ffmpeg` and [Ollama](https://ollama.com) are installed and running on your system.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
The tool can be executed with the following command line options:
|
The tool can be executed with the following command line options:
|
||||||
|
|||||||
@@ -18,8 +18,14 @@ dependencies = [
|
|||||||
"transformers>=4.50.2",
|
"transformers>=4.50.2",
|
||||||
"yt-dlp>=2025.3.27",
|
"yt-dlp>=2025.3.27",
|
||||||
]
|
]
|
||||||
|
[project.scripts]
|
||||||
|
audio-summary = "summary:main"
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
py-modules = []
|
py-modules = ["summary"]
|
||||||
|
|
||||||
|
[tool.setuptools.package-dir]
|
||||||
|
"" = "src"
|
||||||
|
|
||||||
[tool.ruff]
|
[tool.ruff]
|
||||||
# Exclude a variety of commonly ignored directories.
|
# Exclude a variety of commonly ignored directories.
|
||||||
|
|||||||
Reference in New Issue
Block a user