Prepare publication on PyPI

Author: amigrave

LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2014 Fabien Meghazi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -9,10 +9,7 @@ Of course you do ! Why would you be there ?
 Installation
 ------------
 
-Just type this in your terminal:
-
-    sudo wget https://raw.githubusercontent.com/amigrave/git-qdiff/master/git-qdiff -P /usr/local/bin
-    sudo chmod +x /usr/local/bin/git-qdiff
+    pip install git-qdiff
 
 Dependencies
 ------------
@@ -29,20 +26,24 @@ Once installed, you should be able to use this command from any git repository:
 
     git qdiff
 
+And this should launch your favorite difftool:
+
+[![screenshot](https://github.com/amigrave/git-qdiff/raw/master/screenshot.png)]
+
 Of course you can use the same notations as you would with `git diff`:
 
 ```bash
 # Show both staged and unstaged changes
-git qdiff HEAD
+$ git qdiff HEAD
 
 # Using tilde and carrets
-git qdiff HEAD~2..HEAD~3
+$ git qdiff HEAD~2..HEAD~3
 
 # Between commits
-git qdiff 53c43de..7c70faf
+$ git qdiff 53c43de..7c70faf
 
 # Between branches
-git qdiff my_feature..origin/master
+$ git qdiff my_feature..origin/master
 
 # ...
 ```
@@ -53,3 +54,8 @@ Known problem
 - `Refresh` button won't work
 
 Before reporting an issue, please check that your `bzr qdiff` tool works well.
+
+License
+-------
+
+This software is licensed under the MIT license

git-qdiff

@@ -1,59 +1,8 @@
 #!/usr/bin/env python
-import os
-from os.path import join as opj
-import subprocess
-import sys
-
-class UnmetDependency(OSError):
-    pass
-
-def qdiff(left, right):
-    left, right = opj(left, ''), opj(right, '')
-    os.chdir(left)
-    subprocess.check_call(['bzr', 'init', '-q'])
-    subprocess.check_call(['bzr', 'add', '-q'])
-    subprocess.check_call(['bzr', 'commit', '-qmm'])
-    subprocess.check_call(['rsync', '-qavLt', '--delete', '--exclude=/.bzr', right, left])
-    subprocess.check_call(['bzr', 'add', '-q'])
-    subprocess.check_call(['bzr', 'qdiff', '-q'])
-
-def check_dependencies():
-    try:
-        gitv = subprocess.check_output(['git', '--version']).split()[-1]
-    except subprocess.CalledProcessError:
-        raise UnmetDependency("Could not find `git` program")
+# -*- coding: utf-8 -*-
 
-    ver = map(int, gitv.split('.')[0:3])
-    if cmp(ver, [1, 7, 11]) < 0:
-        raise UnmetDependency("Need at least `git` version 1.7.11+")
-
-    try:
-        bzrv = subprocess.check_output(['bzr', 'version']).splitlines()[0].split()[-1]
-    except subprocess.CalledProcessError:
-        raise UnmetDependency("Could not find `bzr` program")
-
-    try:
-        subprocess.check_output(['bzr', 'qdiff', '--help'])
-    except subprocess.CalledProcessError:
-        raise UnmetDependency("Could not find `bzr qdiff` plugin")
-
-    return gitv and bzrv # TODO: check minimum requirements
+import sys
+import git_qdiff
 
-if __name__ == '__main__':
-    try:
-        check_dependencies()
-    except Exception, e:
-        sys.exit(e.message)
-    if len(sys.argv) == 3:
-        left, right = sys.argv[1:3]
-        if os.path.isdir(left) and os.path.isdir(right):
-            qdiff(left, right)
-            sys.exit(0)
+sys.exit(git_qdiff.main())
 
-    # TODO: ensure infinite subcalls is not possible
-    cmd = ['git', 'difftool', '-d', '-x'] + sys.argv
-    # print("Launching '%s'" % ' '.join(cmd))
-    try:
-        subprocess.check_call(cmd)
-    except subprocess.CalledProcessError, e:
-        sys.exit("git failed with returncode %d" % e.returncode)

git_qdiff.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+from os.path import join as opj
+import subprocess
+import sys
+
+class UnmetDependency(OSError):
+    pass
+
+def qdiff(left, right):
+    left, right = opj(left, ''), opj(right, '')
+    os.chdir(left)
+    subprocess.check_call(['bzr', 'init', '-q'])
+    subprocess.check_call(['bzr', 'add', '-q'])
+    subprocess.check_call(['bzr', 'commit', '-qmm'])
+    subprocess.check_call(['rsync', '-qavLt', '--delete', '--exclude=/.bzr', right, left])
+    subprocess.check_call(['bzr', 'add', '-q'])
+    subprocess.check_call(['bzr', 'qdiff', '-q'])
+
+def check_dependencies():
+    try:
+        gitv = subprocess.check_output(['git', '--version']).split()[-1]
+    except subprocess.CalledProcessError:
+        raise UnmetDependency("Could not find `git` program")
+
+    ver = map(int, gitv.split('.')[0:3])
+    if cmp(ver, [1, 7, 11]) < 0:
+        raise UnmetDependency("Need at least `git` version 1.7.11+")
+
+    try:
+        bzrv = subprocess.check_output(['bzr', 'version']).splitlines()[0].split()[-1]
+    except subprocess.CalledProcessError:
+        raise UnmetDependency("Could not find `bzr` program")
+
+    try:
+        subprocess.check_output(['bzr', 'qdiff', '--help'])
+    except subprocess.CalledProcessError:
+        raise UnmetDependency("Could not find `bzr qdiff` plugin")
+
+    return gitv and bzrv # TODO: check minimum requirements
+
+def main():
+    try:
+        check_dependencies()
+    except Exception, e:
+        sys.exit(e.message)
+    if len(sys.argv) == 3:
+        left, right = sys.argv[1:3]
+        if os.path.isdir(left) and os.path.isdir(right):
+            qdiff(left, right)
+            sys.exit(0)
+
+    # TODO: ensure infinite subcalls is not possible
+    cmd = ['git', 'difftool', '-d', '-x'] + sys.argv
+    # print("Launching '%s'" % ' '.join(cmd))
+    try:
+        subprocess.check_call(cmd)
+    except subprocess.CalledProcessError, e:
+        sys.exit("git failed with returncode %d" % e.returncode)

screenshot.png

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+with open('README.md') as f:
+    long_description = f.read()
+
+setup(
+    name='git-qdiff',
+    version='0.1',
+    author='Fabien Meghazi',
+    author_email='[email protected]',
+    license='MIT',
+    description="Bzr tool's qdiff for git",
+    long_description=long_description,
+    keywords='git qdiff bzr diff',
+    url = 'https://github.com/amigrave/git-qdiff',
+    py_modules = ['git_qdiff'],
+    scripts = ['git-qdiff'],
+)
+