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

Commit

Permalink
modified readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AbstractGeek committed Dec 2, 2017
1 parent 5f24244 commit a61190b
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 33 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,6 @@ ENV/

# Rope project settings
.ropeproject

# Idea files
.idea
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Comic-scraper (Comic/Manga Downloader)
Downloads comics and manga from various websites and creates cbz files from them.
Currently supports readcomics.tv, mangafox.me and mangahere.co
Downloads comics and manga from various websites and creates pdf or cbz files from them.
Currently supports mangafox.me and mangahere.co (more coming up soon).

## Installation

### Via pip
To install the comic scraper, simply type this into your terminal (sudo might be necessary):
To install the comic scraper, simply type this into your terminal (```sudo -EH``` might be necessary):
```
pip install comic-scraper
```
Expand All @@ -28,6 +28,7 @@ The script is written in python. It requires the following packages:
1. BeautifulSoup4
2. requests
3. futures (concurrent.futures)
4. img2pdf

These can simply be installed by:
```
Expand All @@ -36,37 +37,33 @@ pip install -r requirements.txt
That's it. Use comic_scraper.py to download comics and manga.

## Usage
### Comics
Find your comic of interest in readcomics.tv. Copy the url of the comic page.
For example, If I wanted to download spider-man-2016, I need to copy this url:
http://www.readcomics.tv/comic/spider-man-2016
### Manga
Find your comic of interest in mangafox/mangahere. Copy the url of the comic page (https supported).
For example, If I wanted to download kingdom manga, I need to copy this url:
https://mangafox.me/manga/kingdom/

To download all the chapters of the comic, simply call the script and input the url.
```
comic-scraper http://www.readcomics.tv/comic/spider-man-2016
comic-scraper https://mangafox.me/manga/kingdom/
```

If you want to set a custom location, add -l and input the location
```
comic-scraper -l ~/Comics/ http://www.readcomics.tv/comic/spider-man-2016
comic-scraper -l ~/Comics/ https://mangafox.me/manga/kingdom/
```

If you want to download a select few chapters, add -c and input the chapter numbers.
For example, if I want to download chapters 10-20, I use the following command
```
comic-scraper -l ~/Comics/ -c 10:20 http://www.readcomics.tv/comic/spider-man-2016
comic-scraper -l ~/Comics/ -c 10:20 https://mangafox.me/manga/kingdom/
```
Note: Only individual chapters or sequential chunks (start:stop) can currently be downloaded.

### Manga
The syntax for downloading manga is exactly the same as the comics. For example, if I wanted to download kindom manga, I need to copy the url from mangafox (or mangahere) website: http://mangafox.me/manga/kingdom/

To download all chapters of this manga, simply call the script and input the url.
Download format can be specified too. The current default is pdf, but comics can be downloaded as cbz files using the following command.
```
comic-scraper http://mangafox.me/manga/kingdom/
comic-scraper -l ~/Comics/ -c 10:20 -f cbz https://mangafox.me/manga/kingdom/
```

To download selected chapters, add -c and input the chapter numbers. To set a custom location, add -l and input the location. Here is an example:
```
comic-scraper -l ~/Comics/ -c 1:100 http://mangafox.me/manga/kingdom/
```

### Comics
Coming soon...
34 changes: 20 additions & 14 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
from setuptools import setup

setup(name='comic-scraper',
version='0.5.2',
description='Scraps comics,mangas and creates cbz files for offline reading',
version='0.6.0',
description='Scraps comics,mangas and creates cbz (/pdf) files for offline reading',
url='https://github.com/AbstractGeek/comic-scraper',
download_url='https://github.com/AbstractGeek/comic-scraper/tarball/0.5.2',
download_url='https://github.com/AbstractGeek/comic-scraper/tarball/0.6.0',
author='Dinesh Natesan',
author_email='[email protected]',
license='MIT',
classifiers=[
'Development Status :: 3 - Alpha',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3.5',
'Topic :: Games/Entertainment',
'Development Status :: 3 - Alpha',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3.5',
'Topic :: Games/Entertainment',
],
keywords='comics manga scraper',
packages=['comic_scraper'],
install_requires=[
'beautifulsoup4',
'futures',
'requests',
'numpy'
'beautifulsoup4==4.6.0',
'certifi==2017.7.27.1',
'chardet==3.0.4',
'futures==3.1.1',
'idna==2.6',
'img2pdf==0.2.4',
'olefile==0.44',
'Pillow==4.3.0',
'requests==2.18.4',
'urllib3==1.22'
],
entry_points={
'console_scripts':
['comic-scraper=comic_scraper.comic_scraper:main'],
},
'console_scripts':
['comic-scraper=comic_scraper.comic_scraper:main'],
},
include_package_data=True,
zip_safe=False)

0 comments on commit a61190b

Please sign in to comment.