Make pip compatible

Author: HR

Pipfile

@@ -1,5 +1,5 @@
 # GitHub clone
-Git clone sub-directories of a GitHub repository (at any reference) without having to clone the entire repository.
+Git clone any sub-directories of any GitHub repository (at any reference) without having to clone the entire repository.
 Uses the GitHub API to recursively clone the sub-directories tree and files.
 
 # Rate limit

Pipfile.lock

@@ -1,3 +1,5 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8
 """
 GitHub clone (git.io/ghclone)
 
@@ -22,23 +24,22 @@
 """
 import requests
 import re
-import sys
 import os
 import errno
+from sys import exit
 from docopt import docopt
 
-VERSION = '1.0.0'
+__version__ = '1.0.0'
 GH_API_BASE_URL = 'https://api.github.com'
 GH_REPO_CONTENTS_ENDPOINT = GH_API_BASE_URL + '/repos/{}/{}/contents'
 BASE_NORMALIZE_REGEX = re.compile(r'.*github\.com\/')
 
-verbose = False
 req = requests.Session()
-req.headers.update({'User-Agent': 'git.io/ghclone '+VERSION})
+req.headers.update({'User-Agent': 'git.io/ghclone '+__version__})
 
 def exit_with_m(m='An error occured'):
     print(m)
-    sys.exit(1)
+    exit(1)
 
 def mkdir_p(path):
     try:
@@ -94,11 +95,11 @@ def clone(base_url, path=None, ref=None):
 ###
 # Main
 ###
-if __name__ == '__main__':
+def main():
     arguments = docopt(__doc__)
     if arguments['--version']:
-        print(VERSION)
-        sys.exit(0)
+        print(__version__)
+        exit(0)
 
     # Get params
     gh_url = arguments['<url>']
@@ -114,4 +115,7 @@ def clone(base_url, path=None, ref=None):
     api_req_url = GH_REPO_CONTENTS_ENDPOINT.format(user, repo)
     print("Cloning into '%s'..." % path)
     clone(api_req_url, path, ref)
-    print("done.")
+    print("done.")
+
+if __name__ == '__main__':
+    main()

README.md

@@ -0,0 +1,57 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+import codecs
+import os
+import re
+from setuptools import find_packages, setup
+
+
+version_regex = r'__version__ = ["\']([^"\']*)["\']'
+with open('ghclone.py',) as f:
+    text = f.read()
+    match = re.search(version_regex, text)
+
+    if match:
+        version = match.group(1)
+    else:
+        raise RuntimeError("No version number found!")
+
+
+def local_file(name):
+    return os.path.relpath(os.path.join(os.path.dirname(__file__), name))
+
+
+README = local_file('README.md')
+long_description = codecs.open(README, encoding='utf-8').read()
+
+
+setup(
+    name='ghclone',
+    version=version,
+    description='A script for cloning any sub-directories of any GitHub repository',
+    long_description=long_description,
+    url='https://github.com/HR/github-clone',
+    author='Habib Rehman',
+    author_email='h@rehman.email',
+    license='Apache 2.0',
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Environment :: Console',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+    ],
+    install_requires=[
+        'requests>=2.20.0',
+        'docopt>=0.6.2',
+    ],
+    entry_points={
+        'console_scripts': [
+            'ghclone=ghclone:main',
+        ],
+    },
+)