Update README.md

egbertbouman · Sep 7, 2022 · b1b6c32 · b1b6c32
1 parent 4c0b59b
commit b1b6c32
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -15,35 +15,44 @@ Or directly from the GitHub repository:
 pip install https://github.com/egbertbouman/youtube-comment-downloader/archive/master.zip
 ```
 
-### Usage
+### Usage as command-line interface
 ```
 $ youtube-comment-downloader --help
 usage: youtube-comment-downloader [--help] [--youtubeid YOUTUBEID] [--url URL] [--output OUTPUT] [--limit LIMIT] [--language LANGUAGE] [--sort SORT]
 
 Download Youtube comments without using the Youtube API
 
 optional arguments:
-  --help, -h            Show this help message and exit
-  --youtubeid YOUTUBEID, -y YOUTUBEID
-                        ID of Youtube video for which to download the comments
-  --url URL, -u URL     Youtube URL for which to download the comments
-  --output OUTPUT, -o OUTPUT
-                        Output filename (output format is line delimited JSON)
-  --limit LIMIT, -l LIMIT
-                        Limit the number of comments
-  --language LANGUAGE, -a LANGUAGE
-                        Language for Youtube generated text (e.g. en)
-  --sort SORT, -s SORT  Whether to download popular (0) or recent comments (1). Defaults to 1
+  --help, -h                             Show this help message and exit
+  --youtubeid YOUTUBEID, -y YOUTUBEID    ID of Youtube video for which to download the comments
+  --url URL, -u URL                      Youtube URL for which to download the comments
+  --output OUTPUT, -o OUTPUT             Output filename (output format is line delimited JSON)
+  --limit LIMIT, -l LIMIT                Limit the number of comments
+  --language LANGUAGE, -a LANGUAGE       Language for Youtube generated text (e.g. en)
+  --sort SORT, -s SORT                   Whether to download popular (0) or recent comments (1). Defaults to 1
 ```
 
 For example:
 ```
-youtube-comment-downloader --youtubeid ScMzIvxBSi4 --output ScMzIvxBSi4.json
+youtube-comment-downloader --url https://www.youtube.com/watch?v=ScMzIvxBSi4 --output ScMzIvxBSi4.json
 ```
-or using the URL:
+or using the youtube ID:
 ```
-youtube-comment-downloader --url https://www.youtube.com/watch?v=ScMzIvxBSi4 --output ScMzIvxBSi4.json
+youtube-comment-downloader --youtubeid ScMzIvxBSi4 --output ScMzIvxBSi4.json
 ```
 
 For Youtube IDs starting with - (dash) you will need to run the script with:
 `-y=-idwithdash` or `--youtubeid=-idwithdash`
+
+
+### Usage as library
+You can also use this script as a library. For instance, if you want to print out the 10 most popular comments for a particular Youtube video you can do the following:
+
+
+```python
+from youtube_comment_downloader import *
+downloader = YoutubeCommentDownloader()
+comments = downloader.get_comments_from_url('https://www.youtube.com/watch?v=ScMzIvxBSi4', sort_by=SORT_BY_POPULAR)
+for comment in list(comments)[:10]:
+    print(comment)
+```
diff --git a/youtube_comment_downloader/__init__.py b/youtube_comment_downloader/__init__.py
@@ -5,7 +5,7 @@
 import sys
 import time
 
-from .downloader import YoutubeCommentDownloader, SORT_BY_RECENT
+from .downloader import YoutubeCommentDownloader, SORT_BY_POPULAR, SORT_BY_RECENT
 
 
 def main(argv = None):