Skip to main content

No project description provided

Project description

YouTube Summary CLI

A simple CLI tool that summarizes YouTube videos.

Screenshot

The timestamp 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.3.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

youtube_summary-0.3-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtube-summary-0.3.tar.gz
  • Upload date:
  • Size: 5.2 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.3.tar.gz
Algorithm Hash digest
SHA256 c93a3eaed2aa8b55f97842e59ccd80249a82ac10a16e0248a42af69954f9cb02
MD5 8e004b22658f52e66fabd9d3863f1d64
BLAKE2b-256 9fc1bf353ced22aebc8bde90fb4afb43c564b52d6740edb30d02eddc99464c02

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtube_summary-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ad727919b9bf895f9097bc19e9700277659a8c2cd1ad11bbe253afd6f79c31af
MD5 4f9efb8d8840637468542850c0ad38c6
BLAKE2b-256 a5aa5a1c6f523dc912c70096d9adb3931d776a637ecd34fd5f8e2a2cf2b87974

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