From bcbe71322e8a98cefb2e8ccebc0eb589a1800251 Mon Sep 17 00:00:00 2001 From: vgvr0 <126200367+vgvr0@users.noreply.github.com> Date: Tue, 29 Oct 2024 18:50:41 +0100 Subject: [PATCH] Update README.md --- README.md | 94 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 75 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 9b347c5..9a2185a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,82 @@ -# TikTok Video Downloader +# πŸ“± TikTok Video Downloader -## Description: -The TikTok Video Saver is a Python tool that allows users to download TikTok videos using the tiktok_scraper library. It provides a simple command-line interface to download videos from TikTok profiles and includes additional functionalities: +> πŸš€ Download TikTok videos quickly and easily! A simple yet powerful Python tool. -1. Automatic Video Renaming: After downloading a video, it automatically renames the file with a β€œtiktok_” prefix for easy identification. -2. Video Metadata Retrieval: The tool can also fetch metadata for the downloaded video, including details like the number of likes, comments, and views. +## ✨ Key Features -## Installation: -Clone this repository to your local machine: -```git clone https://github.com/your-username/tiktok-video-saver.git``` +🎯 What you can do with this tool: +- πŸ“₯ Download TikTok videos using URLs +- 🏷️ Automatic video renaming with 'tiktok_' prefix +- πŸ“Š Video metadata retrieval +- πŸ›‘οΈ Robust error handling -Install the necessary dependencies: -```pip install tiktok-scraper``` +## πŸ”§ Prerequisites -## Usage: -1. Run the `download_tiktok_video.py` script, providing the TikTok video URL and the output directory: -```python download_tiktok_video.py --url https://www.tiktok.com/@username/video/123456789 --output /path/to/directory``` -The video will be downloaded and saved in the specified folder. The renamed video will have the β€œtiktok_” prefix. -2. To retrieve video metadata, use the `get_video_metadata` function within the same script. +- 🐍 Python 3.6 or higher +- πŸ“¦ `tiktok-scraper` package -## Contribution: -Contributions are welcome! Feel free to add new features or improve existing ones. +## ⚑️ Installation -## License: -This project is licensed under the MIT License. See the LICENSE file for more details. +### 1️⃣ Clone this repository: +```bash +git clone [repository-url] +cd tiktok-downloader +``` + +### 2️⃣ Install the required package: +```bash +pip install tiktok-scraper +``` + +## πŸ“– Usage + +### 🎯 Basic Usage + +```python +from tiktok_downloader import download_tiktok_video + +# Example +tiktok_url = "https://www.tiktok.com/@username/video/123456789" +download_directory = "/path/to/directory" +download_tiktok_video(tiktok_url, download_directory) +``` + +### πŸ” Function Parameters + +- πŸ”— `video_url` (str): The URL of the TikTok video to download +- πŸ“ `output_dir` (str): The directory where the video will be saved + +## πŸŽ‰ Output + +The script will: +1. ⬇️ Download the video to your specified directory +2. ✏️ Rename the video with a 'tiktok_' prefix +3. πŸ“‹ Print the video metadata +4. πŸ’¬ Display success/error messages during the process + +## πŸ“ Example Output + +``` +Downloaded video: /path/to/directory/video123.mp4 +Renamed video: /path/to/directory/tiktok_video123.mp4 +Video metadata: {video_information_object} +``` + +## ⚠️ Error Handling + +The script includes error handling that will: +- 🚫 Catch and display any errors during download +- πŸ“’ Print informative error messages +- πŸ›‘οΈ Prevent script crashes due to download failures + +## 🀝 Contributing + +Feel free to submit issues and enhancement requests! We love community contributions! ✨ + + +## βš–οΈ Disclaimer + +This tool is for educational purposes only. Please ensure you have the right to download and use any content from TikTok before using this script. + +--- +### 🌟 Made with ❀️ for the TikTok Developer Community