Skip to content
This repository was archived by the owner on Apr 2, 2024. It is now read-only.

Commit fd18082

Browse files
committed
Added requirements, updated readme
1 parent de0402e commit fd18082

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
1-
# comic-scrapper
2-
Scrappers comics from various websites and creates cbz files from them
1+
# Comic-Scrapper
2+
Downloads comics from various websites and creates cbz files from them.
3+
Currently supports just readcomics.tv
4+
5+
## Requirements
6+
The script is written in python3. It requires the following packages:
7+
1) BeautifulSoup4
8+
2) requests
9+
3) futures (concurrent.futures)
10+
11+
These can simply be installed by:
12+
'''
13+
pip install -r requirements.txt
14+
'''
15+
16+
## Usage
17+
Find your comic of interest in readcomics.tv. Copy the url of the comic page.
18+
For example, If I wanted to download spider-man-2016, I need to copy this url:
19+
http://www.readcomics.tv/comic/spider-man-2016
20+
21+
To download all the chapters of the comic, simply call the script and input the url.
22+
'''
23+
python comic-scrapper http://www.readcomics.tv/comic/spider-man-2016
24+
'''
25+
26+
If you want to set a custom location, add -l and input the location
27+
'''
28+
python comic-scrapper -l ~/Comics/ http://www.readcomics.tv/comic/spider-man-2016
29+
'''
30+
31+
You can also make the comic-scrapper script an executable and call it directly
32+
'''
33+
chmod +x comic-scrapper
34+
./comic-scrapper -l ~/Comics/ http://www.readcomics.tv/comic/spider-man-2016
35+
'''
36+
37+
(Chapter selection option coming up soon)

requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
beautifulsoup4==4.5.1
2+
futures==3.0.5
3+
requests==2.9.1

0 commit comments

Comments
 (0)