Skip to main content

No project description provided

Project description

YouTube Summary CLI

A simple CLI tool that summarizes YouTube videos.

Screenshot

The timestamps are also clickable, try them 🙂

Installation

Install from PyPi

You can install the application using pip or pipx:

pip install --user youtube-summary

or

pipx install youtube-summary

Compile from source

You can compile directly from source:

git clone https://github.com/mmaorc/youtube-summary-cli
cd youtube-summary-cli
python setup.py install --user

Development

For development purposes, clone the repository, navigate to the project directory, and install in a virtual environment:

git clone https://github.com/mmaorc/youtube-summary-cli
cd youtube-summary-cli
python -m venv .env
source .env/bin/activate  # On Windows use `.env\Scripts\activate`
pip install --editable .

Usage

Prior to running the script, ensure that the OPENAI_API_KEY environment variable is set up correctly.

To summarize the transcript of a YouTube video, run the app.py script with the video URL as an argument:

youtube-summary "https://www.youtube.com/watch?v=your_video_id"

Replace your_video_id with the actual video ID.

Note that generating a summary might take a couple of minutes, depending on the video's transcript length.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

youtube-summary-0.4.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

youtube_summary-0.4-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file youtube-summary-0.4.tar.gz.

File metadata

  • Download URL: youtube-summary-0.4.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for youtube-summary-0.4.tar.gz
Algorithm Hash digest
SHA256 04f89638c20dc5c50dbe0251242dea23d43e603cceb8d015b9b7971d1ce2f3ee
MD5 b259865c8e52e793426bd4c325193ae1
BLAKE2b-256 2346282f48606132c76bb9bcdf4af0e910978c47d1dd883b58ed1f15e5989f37

See more details on using hashes here.

File details

Details for the file youtube_summary-0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for youtube_summary-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3c2261086a77a61d0c2129553c4ff3705b0e413b5ac8bcb57b48072ac4401ca0
MD5 657f40db1e499f1e88002d67f9572a8b
BLAKE2b-256 6eb20b610c8046deadce1fd877ac13d3c57868d7dbde4fe8f35232163f563252

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page