Damien/audio-summary-with-local-LLM
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: Damien:dabdac4dc9afef6b796beef8ff5c86a8ee80ce7a
Branches Tags
Damien:main Damien:chore/update_libraries
..
compare: Damien:1d8703a0ce95f4e759f2aadf9e9e08ada34d8ead
Branches Tags
Damien:chore/update_libraries Damien:main

2 Commits
dabdac4dc9 ... 1d8703a0ce

Author SHA1 Message Date
Damien Arnodo
1d8703a0ce Merge pull request 'Add uvx usage instructions and package configuration' (#1) from chore/documentation_uvx into main 
Reviewed-on: #1
 2026-06-07 15:59:36 +00:00
Damien
cd69127473 Add uvx usage instructions and package configuration 
The README now includes a new "Usage with uvx" section showing how to
run the tool directly without installation. The pyproject.toml has been
updated to add the package script entry point and configure setuptools
to include the src directory.
 2026-06-07 15:17:49 +02:00
2 changed files with 29 additions and 2 deletions
Expand all files Collapse all files

23
README.md
View File

@@ -48,10 +48,31 @@ Download and use the Llama3 model:
```bash
ollama pull llama3
## Test the access:
# Test the access:
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
The tool can be executed with the following command line options:

8
pyproject.toml
View File

@@ -18,8 +18,14 @@ dependencies = [
"transformers>=4.50.2",
"yt-dlp>=2025.3.27",
]
[project.scripts]
audio-summary = "summary:main"
[tool.setuptools]
py-modules = []
py-modules = ["summary"]
[tool.setuptools.package-dir]
"" = "src"
[tool.ruff]
# Exclude a variety of commonly ignored directories.