From a619fd7adb76feeb2c18be7e8905c697552aa20f Mon Sep 17 00:00:00 2001
From: Jan C <45429314+jc-a3s@users.noreply.github.com>
Date: Tue, 7 Feb 2023 21:45:29 +0100
Subject: [PATCH] Readme
---
README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 48 insertions(+)
diff --git a/README.md b/README.md
index e69de29..43a42fd 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,48 @@
+# TikTok Analyzer
+It was created to show how you can crawl videos from TikTok and convert speech (coming from video) to text.
+
+Used libraries:
+* [https://github.com/Russell-Newton/TikTokPy](TikTokPy)
+* [https://github.com/openai/whisper](Whisper)
+
+You need to clone the repository or download zipped project to run it.
+```
+git clone https://github.com/data-hunters/tiktok-analyzer.git
+```
+In next step, install required libraries:
+```
+pip install tiktokapipy
+python -m playwright install
+pip install whisper-openai
+```
+
+## Examples
+
+Displaying help:
+```
+python run.py --help
+```
+
+Downloading 10 latest videos (with soundtrack) by hashtag `ukraine` to `tiktok_videos` directory:
+```
+python run.py --hashtag ukraine --output-path tiktok_videos --max-videos 10
+```
+
+Downloading 10 latest videos (with soundtrack) of `test123` user to `tiktok_videos` directory:
+```
+python run.py --user test123 --output-path tiktok_videos --max-videos 10
+```
+
+Converting speech to text based on `mp3` files located in `tiktok_videos`, using OpenAI Whisper `medium` model and saving the output to `tiktok_transcription` directory:
+```
+python run.py --transcribe --input-path tiktok_videos --output-path tiktok_transcription --model medium
+```
+
+Running all of the above steps with single command:
+```
+python run.py --hashtag ukraine --user test123 --max-videos 10 --transcribe --input-path tiktok_videos --output-path tiktok_videos --model medium
+```
+
+
+
+[](http://datahunters.ai)
\ No newline at end of file