add dulwich to required packages in setup

* change version file check to use CONSTANTS instead of function
get_or_create_version()
* add comments
* use importlib to get version file, instead of hardcode name, so
this can be reused in other packages
* ignore version.py
* cherry pick ignores from quickstart branch
*

Signed-off-by: Mark Mikofski <mark.mikofski@sunpowercorp.com>

Author: mikofski

.gitignore

@@ -12,6 +12,7 @@
 dist/
 build/
 *.egg-info/
+version.py
 
 # docs
 carousel/docs/_build/
@@ -20,3 +21,8 @@ carousel/docs/_build/
 .cache/
 __pycache__
 carousel/tests/xlrdreader_testdata.xlsx.json
+.coverage
+cover/
+classes_Carousel.png
+packages_Carousel.png
+make_uml_diagram

carousel/__init__.py

@@ -7,29 +7,32 @@
 from carousel.release_robot import get_current_version
 from dulwich.repo import NotGitRepository
 import os
+import importlib
 
-BASEDIR = os.path.dirname(__file__)
-
-
-def get_or_create_version(verfile='version.py'):
-    try:
-        git_version = get_current_version()
-    except (ImportError, NotGitRepository):
-        git_version = None
-    try:
-        from carousel.version import VERSION
-    except ImportError:
-        VERSION = None
-    if git_version is not None and VERSION != git_version:
-        with open(os.path.join(BASEDIR, verfile), 'w') as vf:
-            vf.write('VERSION = "%s"\n' % git_version)
-    else:
-        git_version = VERSION
-    return git_version
-
+BASEDIR = os.path.dirname(__file__)  # this directory
+VER_FILE = 'version'  # name of file to store version
+# use release robot to try to get current Git tag
+try:
+    GIT_TAG = get_current_version()
+except NotGitRepository:
+    GIT_TAG = None
+# check version file
+try:
+    version = importlib.import_module('%s.%s' % (__name__, VER_FILE))
+except ImportError:
+    VERSION = None
+else:
+    VERSION = version.VERSION
+# update version file if it differs from Git tag
+if GIT_TAG is not None and VERSION != GIT_TAG:
+    with open(os.path.join(BASEDIR, VER_FILE + '.py'), 'w') as vf:
+        vf.write('VERSION = "%s"\n' % GIT_TAG)
+else:
+    GIT_TAG = VERSION  # if Git tag is none use version file
+VERSION = GIT_TAG  # version
 
 __author__ = u'Mark Mikofski'
 __email__ = u'mark.mikofski@sunpowercorp.com'
 __url__ = u'https://github.com/SunPower/Carousel'
-__version__ = get_or_create_version()
+__version__ = VERSION
 __release__ = u'Caramel Corn'

setup.py

@@ -22,7 +22,8 @@
 
 REQUIRES = [
     'numpy', 'xlrd', 'scipy', 'python_dateutil', 'numexpr', 'pint (>=0.7.2)',
-    'UncertaintyWrapper (>=0.4.1)', 'sphinx', 'nose', 'pandas', 'pytz', 'pvlib'
+    'UncertaintyWrapper (>=0.4.1)', 'sphinx', 'nose', 'pandas', 'pytz',
+    'pvlib (>=0.4.2)', 'dulwich'
 ]
 INST_REQ = ['%s%s' % (r[0], r[1][1:-1]) if len(r) == 2 else r[0]
             for r in (r.split() for r in REQUIRES)]