diff --git a/README.md b/README.md index 2d26e7c..df647c2 100644 --- a/README.md +++ b/README.md @@ -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 + +# Summarize a local audio file +uvx --from git+https://github.com/damienarnodo/audio-summary-with-local-LLM.git audio-summary --from-local + +# Transcribe only (no summary) +uvx --from git+https://github.com/damienarnodo/audio-summary-with-local-LLM.git audio-summary --from-youtube --transcript-only + +# Specify language and output file +uvx --from git+https://github.com/damienarnodo/audio-summary-with-local-LLM.git audio-summary --from-local --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: diff --git a/pyproject.toml b/pyproject.toml index 6ed6010..6a3886a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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.