Updated setup file, added VERSION file, added requirements

- added bump, buildout, test commands to setup.py
- added VERSION file for version number
- added requirements files, to be nice with *env people
- added support for requirements in setup and buildout

Signed-off-by: Guyzmo <[email protected]>

Author: guyzmo

README.md

@@ -243,8 +243,6 @@ To use your own credentials, you can setup the following environment variables:
   * [ ] gitlab support (cf [#12](https://github.com/guyzmo/git-repo/issues/12))
   * [ ] bitbucket support (cf [#13](https://github.com/guyzmo/git-repo/issues/13))
 * [ ] add support for handling pull requests
-  * [x] list them
-  * [x] fetch them as local branches
   * [x] github support
   * [ ] gitlab support (cf [#10](https://github.com/guyzmo/git-repo/issues/10))
   * [ ] bitbucket support (cf [#11](https://github.com/guyzmo/git-repo/issues/11))

VERSION

@@ -0,0 +1 @@
+1.6.0

buildout.cfg

@@ -7,29 +7,29 @@ develop = .
 eggs-directory     = ${buildout:directory}/var/eggs
 develop-eggs-directory = ${buildout:directory}/var/develop-eggs
 parts-directory    = ${buildout:directory}/var/parts
-develop-dir        = ${buildout:directory}/var/clone/
-#extensions=gp.vcsdevelop
-#vcs-extend-develop=git+https://github.com/gitpython-developers/GitPython#egg=GitPython
+# develop-dir        = ${buildout:directory}/var/clone/
+# extensions=gp.vcsdevelop
+# vcs-extend-develop=git+https://github.com/gitpython-developers/GitPython#egg=GitPython
 
 [git_repo]
 recipe = zc.recipe.egg
 eggs =
+    ${git_repo-pip:eggs}
     git_repo
 interpreter = python3
 
 [pytest]
 recipe = zc.recipe.egg
 arguments = ['--cov=git_repo', '--cov-report', 'term-missing', '--capture=sys', 'tests']+sys.argv[1:]
-eggs = pytest
-       pytest-cov
-       pytest-xdist
-       pytest-sugar
-       pytest-catchlog
-       pytest-datadir-ng
-       testfixtures
-       mock
-       betamax==0.5.1
-       betamax-serializers
-       git_repo
+eggs = ${pytest-pip:eggs}
 interpreter = python3
 
+[git_repo-pip]
+recipe = collective.recipe.pip
+configs = ${buildout:directory}/requirements.txt
+
+[pytest-pip]
+recipe = collective.recipe.pip
+configs = ${buildout:directory}/requirements-test.txt
+
+

requirements-test.txt

@@ -0,0 +1,11 @@
+-r requirements.txt
+pytest
+pytest-cov
+pytest-sugar
+pytest-catchlog
+pytest-datadir-ng
+testfixtures
+mock
+betamax==0.5.1
+betamax-serializers
+git_repo

requirements.txt

@@ -0,0 +1,6 @@
+docopt
+GitPython==2.0.6
+progress==1.2
+python-gitlab==0.13
+github3.py==0.9.5
+bitbucket-api==0.5.0

setup.py

@@ -1,24 +1,35 @@
+#!/usr/bin/env python3
+# encoding: utf-8
 from setuptools import setup, find_packages
 
-import sys
+import sys, os
+
+import pip
+
+from setuptools import setup, find_packages, dist
+from setuptools.command.test import test as TestCommand
+from distutils.core import Command
+from distutils.core import setup
 
 if sys.version_info.major < 3:
     print('Please install with python version 3')
     sys.exit(1)
 
-from distutils.core import Command
-from distutils.core import setup
+# Use buildout's path for eggs
+def get_egg_cache_dir(self):
+    egg_cache_dir = os.path.join(os.curdir, 'var', 'eggs')
+    if not os.path.exists(egg_cache_dir):
+        os.makedirs(egg_cache_dir, exist_ok=True)
+    return egg_cache_dir
+dist.Distribution.get_egg_cache_dir = get_egg_cache_dir
+
 
-class dist_clean(Command):
+class DistClean(Command):
     description = 'Clean the repository from all buildout stuff'
     user_options = []
 
-    def initialize_options(self):
-        pass
-
-    def finalize_options(self):
-        pass
-
+    def initialize_options(self): pass
+    def finalize_options(self): pass
 
     def run(self):
         import shutil, os
@@ -35,8 +46,149 @@ def run(self):
         shutil.rmtree(os.path.join(path, '.installed.cfg'), ignore_errors=True)
         print("Repository is now clean!")
 
+class VersionInfo(type):
+    @property
+    def info(cls):
+        if not cls._info:
+            try:
+                cls._info = list(int(x) for x in open(cls.path, 'r').read().strip().split('.'))
+            except ValueError:
+                print('Version parts shall all be integers')
+                sys.exit(1)
+            if len(cls._info) != 3:
+                print('Version number is not conform, there should be exactly three parts')
+                sys.exit(1)
+        return cls._info
+
+    def __str__(cls):
+        return '.'.join(map(str, cls.info))
+
+
+class Version(Command, metaclass=VersionInfo):
+    description = 'Bump version number'
+    user_options = [
+            ('major', 'M', 'Bump major part of version number'),
+            ('minor', 'm', 'Bump minor part of version number'),
+            ('patch', 'p', 'Bump patch part of version number')]
+    path = os.path.join(os.path.dirname(__file__), 'VERSION')
+    _info = None
+
+    def finalize_options(self, *args, **kwarg): pass
+    def initialize_options(self, *args, **kwarg):
+        self.major = None
+        self.minor = None
+        self.patch = None
+
+    def run(self):
+        MAJOR, MINOR, PATCH = (0,1,2)
+        prev = str(Version)
+        if self.major:
+            Version.info[MAJOR] += 1
+            Version.info[MINOR] = 0
+            Version.info[PATCH] = 0
+        if self.minor:
+            Version.info[MINOR] += 1
+            Version.info[PATCH] = 0
+        if self.patch:
+            Version.info[PATCH] += 1
+        if self.major or self.minor or self.patch:
+            with open(self.path, 'w') as f:
+                f.write(str(Version))
+            print("Bumped version from {} to {}".format(prev, str(Version)))
+        else:
+            print("Please choose at least one part to bump: --major, --minor or --patch!")
+            sys.exit(1)
+
+
+class PyTest(TestCommand):
+    user_options = [
+            ('exitfirst', 'x', "exit instantly on first error or failed test."),
+            ('last-failed', 'l', "rerun only the tests that failed at the last run"),
+            ('verbose', 'v', "increase verbosity"),
+            ('pdb', 'p', "run pdb upon failure"),
+            ('pep8', '8', "perform some pep8 sanity checks on .py files"),
+            ('flakes', 'f', "run flakes on .py files"),
+            ('pytest-args=', 'a', "Extra arguments to pass into py.test"),
+            ]
+    default_options = [
+        '--cov=calenvite', '--cov-report', 'term-missing',
+        '--capture=sys', 'tests'
+    ]
+
+    def initialize_options(self):
+        TestCommand.initialize_options(self)
+        self.pytest_args = set()
+        self.exitfirst = False
+        self.last_failed = False
+        self.verbose = 0
+        self.pdb = False
+        self.pep8 = False
+        self.flakes = False
+
+    def finalize_options(self):
+        TestCommand.finalize_options(self)
+        self.test_args = []
+        self.test_suite = True
+
+    def run_tests(self):
+        import pytest
+        if isinstance(self.pytest_args, str):
+            self.pytest_args = set(self.pytest_args.split(' '))
+        if self.exitfirst:   self.pytest_args.add('-x')
+        if self.pdb:   self.pytest_args.add('--pdb')
+        if self.last_failed: self.pytest_args.add('--last-failed')
+        if self.pep8:        self.pytest_args.add('--pep8')
+        if self.flakes:      self.pytest_args.add('--flakes')
+        self.pytest_args = list(self.pytest_args)
+        if self.verbose:
+            for v in range(self.verbose):
+                self.pytest_args.append('-v')
+        errno = pytest.main(self.pytest_args + self.default_options)
+        sys.exit(errno)
+
+
+class Buildout(Command):
+    description = 'Running buildout on the project'
+    user_options = []
+
+    def initialize_options(self): pass
+    def finalize_options(self): pass
+
+    def run(self):
+        try:
+            from zc.buildout.buildout import main
+        except ImportError:
+            print('Please install buildout!\n  pip install zc.buildout')
+            sys.exit(1)
+        errno = main(sys.argv[sys.argv.index('buildout')+1:])
+        if errno == 0:
+            print('Now you can run tests using: bin/py.test')
+            print('Now you can test current code using: bin/git-repo')
+            print('Thank you 🍻')
+        sys.exit(errno)
+
+
+requirements_links = []
+
+def requirements(spec=None):
+    spec = '{}{}.txt'.format('requirements',
+            '-'+spec if spec else '')
+    requires = []
+
+    requirements = pip.req.parse_requirements(
+        spec, session=pip.download.PipSession())
+
+    for item in requirements:
+        if getattr(item, 'link', None):
+            requirements_links.append(str(item.link))
+        if item.req:
+            requires.append(str(item.req))
+
+    return requires
+
+
 setup(name='git-repo',
-      version='1.6.0',
+      version=str(Version),
       description='Tool for managing remote repositories from your git CLI!',
       classifiers=[
           # 'Development Status :: 2 - Pre-Alpha',
@@ -65,15 +217,15 @@ def run(self):
       ],
       long_description_markdown_filename='README.md',
       include_package_data = True,
-      install_requires=[
-            'docopt',
-            'GitPython==2.0.4',
-            'progress==1.2',
-            'python-gitlab==0.13',
-            'github3.py==0.9.5',
-            'bitbucket-api==0.5.0',
-      ],
-      cmdclass={'dist_clean': dist_clean},
+      install_requires=requirements(),
+      tests_require=requirements('test'),
+      dependency_links=requirements_links,
+      cmdclass={
+          'buildout': Buildout,
+          'dist_clean': DistClean,
+          'test': PyTest,
+          'bump': Version,
+      },
       entry_points="""
       # -*- Entry points: -*-
       [console_scripts]
@@ -82,12 +234,5 @@ def run(self):
       license='GPLv2',
       packages=find_packages(exclude=['tests']),
       test_suite='pytest',
-      tests_require=[
-          'pytest==2.9.1',
-          'pytest-cov',
-          'pytest-sugar',
-          'pytest-catchlog',
-          'pytest-datadir-ng',
-      ],
       zip_safe=False
       )