Skip to content

gnotree/YTSlinger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

Overview of YTSlinger

YTSlinger is a Spider-Man-inspired command-line interface (CLI) tool designed to download YouTube videos and audio. It allows users to input one or more YouTube links and choose to save them as either MP4 files (video with audio) or MP3 files (audio only). The tool is marketed as fast, safe, and free of adware, appealing to users who value efficiency and security.


Sections of the README.md

Header Section

At the top, there’s a note indicating that this is a cleaned-up version of the original README.md:

  • Note: "(o) No worries—I'll clean up the README.md and present it in a single, properly formatted code block. Here's the corrected version for YTSlinger, ensuring it's concise, clear, and unified:"
  • Title: Final README.md

The main content begins with the project title in a level-one heading:

  • # YTSlinger

Description

  • Heading: # Description
  • Text: "A simple, Spider-Man-inspired CLI tool to download YouTube videos and audio. Enter one or more links, choose MP4 (video+audio) or MP3 (audio-only), and sling them to your drive—fast, safe, and adware-free."

This section succinctly explains the tool’s purpose and highlights its key attributes: simplicity, speed, safety, and an ad-free experience, all wrapped in a playful Spider-Man theme.


Installation

  • Heading: # Installation
  • Subheading: **Swing Into Action**

The installation process is split into two main steps:

  1. Clone the Repository:

    • Instructions: Clone the project from GitHub and navigate into the directory.
    • Code Block:
      git clone https://github.com/yourusername/YTSlinger.git
      cd YTSlinger
    • Note: The URL in the image uses yourusername, but other references suggest the correct repository might be https://github.com/gnotree/YTSlinger.git.
  2. Run the Setup Script:

    • Subheading: **Spin the Web**
    • Instructions: Execute a PowerShell script to set up dependencies.
    • Code Block:
      .\setup.ps1

Details of the setup.ps1 Script

A collapsible section labeled "text" provides more information about what the script does:

  • Installs Anaconda 3 if it’s not already present (prompts the user with Y/N).
  • Sets up a Conda environment named %USERNAME%-ML (e.g., gtai8-ML) and installs yt-dlp and ffmpeg within it. If Anaconda isn’t used, these dependencies are installed via pip.
  • Prompts the user to add Anaconda to the system PATH (Y/N).
  • Prompts the user to add an alias ytsh to their PowerShell profile (Y/N).
  • Warning: ***Warning***: Avoid adding aliases in an Admin shell to prevent profile conflicts.

This script automates the setup process, making it user-friendly while accommodating different system configurations.


Usage

  • Subheading: ** Usage **
  • Run Command: - Run: 'ytsh'

The usage section explains how to interact with the tool after installation:

Single Link

  • Subheading: **Single Link**
  • Instructions: "Enter 1, provide the URL, then choose (V)ideo MP4 or (A)udio MP3 each time."
  • Process:
    1. Type ytsh in the terminal.
    2. Enter 1 to indicate a single link.
    3. Input the YouTube URL.
    4. Select (V) for video (MP4) or (A) for audio (MP3).

Multiple Links

  • Subheading: **Multiple Links**
  • Instructions: "Enter the number of links, provide URLs, then choose."
  • Process:
    1. Type ytsh in the terminal.
    2. Enter the number of links (e.g., 3 for three videos).
    3. Provide each YouTube URL one by one.
    4. Choose an option:
      • (V): Download all as MP4 videos concurrently.
      • (A): Download all as MP3 audio files concurrently.
      • (C): Custom mode, where you specify (V) or (A) for each link individually before concurrent downloading.

Visual Presentation

  • Editor Theme: The screenshot uses a dark background (similar to VS Code’s Dark+ theme).
  • Syntax Highlighting:
    • Headings are in red (e.g., # YTSlinger, # Description).
    • Regular text is in black.
    • Code blocks are in light gray boxes with a monospaced font, styled to resemble terminal commands.
  • Layout: The content is well-organized with collapsible sections (labeled "markdown" and "text"), offering options like "Collapse," "Unwrap," and "Copy" for usability.
  • Clarity: The file uses consistent indentation and spacing, making it easy to read and follow.

Summary

The README.md for YTSlinger is a polished, user-friendly guide that covers the tool’s purpose, installation steps, and usage instructions. Its Markdown formatting, complete with headings, subheadings, and code blocks, ensures clarity. The Spider-Man theme adds a fun twist, while the detailed setup script (setup.ps1) and flexible usage options make it accessible to both novice and experienced users. The screenshot captures all this in a visually appealing, dark-themed code editor interface.

About

yt

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published