mirror of
https://github.com/vgvr0/TikTok-Video-Downloader-Python.git
synced 2025-12-22 12:16:22 +00:00
Update README.md
This commit is contained in:
parent
45b0075a45
commit
bcbe71322e
94
README.md
94
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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user