Add setuptools_scm to make application version available in Django, R…

…efs #322

MANIFEST.in

@@ -1,4 +1,4 @@
-include README.rst
+include README.md
 include MANIFEST.in
 recursive-include concordia *
 recursive-include tests *.py

Pipfile

@@ -36,6 +36,7 @@ django-storages = "*"
 markdown = ">=3.0.1"
 "django-bootstrap4" = "*"
 django-robots = "*"
+setuptools-scm = "*"
 
 [dev-packages]
 invoke = "*"

concordia/context_processors.py

@@ -1,4 +1,5 @@
 from django.conf import settings
+from setuptools_scm import get_version
 
 
 def system_configuration(request):
@@ -10,6 +11,7 @@ def system_configuration(request):
         "SENTRY_PUBLIC_DSN": getattr(settings, "SENTRY_PUBLIC_DSN", None),
         "CONCORDIA_ENVIRONMENT": settings.CONCORDIA_ENVIRONMENT,
         "S3_BUCKET_NAME": getattr(settings, "S3_BUCKET_NAME", None),
+        "APPLICATION_VERSION": get_version(),
     }
 
 

concordia/templates/admin/index.html

@@ -37,5 +37,9 @@ <h3>{% trans 'My actions' %}</h3>
             </ul>
             {% endif %}
     </div>
+    <div class="module" id="version-module">
+        <h2>Application Version</h2>
+        <h3>{{ APPLICATION_VERSION }}
+    </div>
 </div>
 {% endblock sidebar%}

setup.py

@@ -2,7 +2,7 @@
 from setuptools import find_packages, setup
 
 VERSION = __import__("concordia").get_version()
-INSTALL_REQUIREMENTS = ["<2.1,>=2.0.9"]
+INSTALL_REQUIREMENTS = ["boto3", "Django<2.1,>=2.0.9"]
 SCRIPTS = ["manage.py"]
 DESCRIPTION = "Transcription crowdsourcing"
 CLASSIFIERS = """\
@@ -12,7 +12,7 @@
 Programming Language :: Python :: 3.6
 """.splitlines()
 
-with open("README.rst", "r") as f:
+with open("README.md", "r") as f:
     LONG_DESCRIPTION = f.read()
 
 
@@ -26,4 +26,9 @@
     scripts=SCRIPTS,
     install_requires=INSTALL_REQUIREMENTS,
     classifiers=CLASSIFIERS,
+    use_scm_version={
+        "write_to": "version.txt",
+        "tag_regex": r"^(?P<prefix>v)?(?P<version>[^\+]+)(?P<suffix>.*)?$",
+    },
+    setup_requires=["setuptools_scm"],
 )