Revamp of structure for pip installation

Author: AbstractGeek

README.md

@@ -2,8 +2,29 @@
 Downloads comics from various websites and creates cbz files from them.
 Currently supports just readcomics.tv
 
-## Requirements
-The script is written in python3. It requires the following packages:
+## Installation
+
+### Via pip
+To install the comic scrapper, simply type this into your terminal (sudo might be necessary):
+```
+pip install comic-scrapper
+```
+
+### Via pip (local)
+Clone a copy of the repository using the following command:
+```
+git clone [email protected]:AbstractGeek/comic-scrapper.git
+```
+
+Open your terminal into the folder and type this into it (sudo might be necessary):
+```
+pip install .
+```
+
+### Manual Installation
+
+#### Requirements
+The script is written in python. It requires the following packages:
 1. BeautifulSoup4
 2. requests
 3. futures (concurrent.futures)
@@ -12,6 +33,7 @@ These can simply be installed by:
 ```
 pip install -r requirements.txt
 ```
+That's it. Use comic_scrapper.py to download comics
 
 ## Usage
 Find your comic of interest in readcomics.tv. Copy the url of the comic page.
@@ -20,23 +42,17 @@ http://www.readcomics.tv/comic/spider-man-2016
 
 To download all the chapters of the comic, simply call the script and input the url.
 ```
-python comic-scrapper http://www.readcomics.tv/comic/spider-man-2016
+comic-scrapper http://www.readcomics.tv/comic/spider-man-2016
 ```
 
 If you want to set a custom location, add -l and input the location
 ```
-python comic-scrapper -l ~/Comics/ http://www.readcomics.tv/comic/spider-man-2016
+comic-scrapper -l ~/Comics/ http://www.readcomics.tv/comic/spider-man-2016
 ```
 
 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
 ```
-python comic-scrapper -l ~/Comics/ -c 10:20 http://www.readcomics.tv/comic/spider-man-2016
+comic-scrapper -l ~/Comics/ -c 10:20 http://www.readcomics.tv/comic/spider-man-2016
 ```
 Note: Only individual chapters or sequential chunks (start:stop) can currently be downloaded.
-
-You can also make the comic-scrapper script an executable and call it directly
-```
-chmod +x comic-scrapper
-./comic-scrapper -l ~/Comics/ http://www.readcomics.tv/comic/spider-man-2016
-```

comic_scrapper/__init__.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 import argparse
 import bs4 as bsoup
 import requests
@@ -115,7 +115,7 @@ def main():
                 raise SyntaxError("Chapter inputs should be separated by ':'")
                 exit()
         else:
-            keys = chapters.keys
+            keys = chapters.keys()
 
         # Download chapters
         if 'readcomics.tv' in url:

comic-scrapper.py comic_scrapper/comic_scrapper.pycomic-scrapper.py renamed to comic_scrapper/comic_scrapper.py

@@ -1,3 +1,3 @@
 beautifulsoup4
 futures
-requests
+requests==2.9.1

requirements.txt

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

setup.cfg

@@ -0,0 +1,22 @@
+from setuptools import setup
+
+setup(name='comic_scrapper',
+      version='0.1',
+      description='Scraps comics and creates cbz files',
+      url='https://github.com/AbstractGeek/comic-scrapper',
+      download_url='https://github.com/AbstractGeek/comic-scrapper',
+      author='Dinesh Natesan',
+      author_email='[email protected]',
+      license='MIT',
+      packages=['comic_scrapper'],
+      install_requires=[
+          'beautifulsoup4',
+          'futures',
+          'requests==2.9.1'
+      ],
+      entry_points={
+        'console_scripts':
+        ['comic-scrapper=comic_scrapper.comic_scrapper:main'],
+        },
+      include_package_data=True,
+      zip_safe=False)