Move version source of truth to esrally/_version.py (elastic#1351)

.readthedocs.yml

@@ -0,0 +1,10 @@
+version: 2
+
+python:
+  version: "3.8"
+  install:
+    - method: pip
+      path: .
+
+sphinx:
+  fail_on_warning: true

MANIFEST.in

@@ -4,7 +4,6 @@ include LICENSE
 include MANIFEST.in
 include README.rst
 include setup.py
-include version.txt
 include esrally/min-es-version.txt
 recursive-include docs *
 recursive-include esrally/resources *

docker/Dockerfiles/Dockerfile-dev

@@ -13,7 +13,6 @@ RUN apt-get -y update && \
 RUN mkdir -p /rally/esrally
 COPY setup.py /rally/
 COPY setup.cfg /rally/
-COPY version.txt /rally/
 COPY README.rst /rally/
 COPY MANIFEST.in /rally/
 COPY esrally/ /rally/esrally/

docs/conf.py

@@ -73,37 +73,34 @@ def setup(app):
     app.connect("source-read", replace_globals)
 
 
-def read_version(version_file="version.txt", full_version=True):
-    with open(join(dirname(__file__), os.pardir, version_file)) as f:
-        raw_version = f.read().strip()
-        return raw_version if full_version else raw_version.replace(".dev0", "")
+def read_min_es_version():
+    with open(join(dirname(__file__), os.pardir, "esrally/min-es-version.txt")) as f:
+        return f.read().strip()
 
 
 year = date.today().year
 
 rst_prolog = f"""
 .. |year| replace:: {year}
 .. |MIN_PY_VER| replace:: {read_min_python_version()}
-.. |min_es_version| replace:: {read_version(version_file="esrally/min-es-version.txt")}
+.. |min_es_version| replace:: {read_min_es_version()}
 """
 
 # General information about the project.
 project = "Rally"
 copyright = "%i, Elasticsearch B.V." % year
 author = "Daniel Mitterdorfer"
 
+import esrally
+
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-
-# development versions always have the suffix '.dev0'
-
-
-version = read_version(full_version=False)
+# Technically the short X.Y version, but let's use the full version, including .dev0
+version = esrally.__version__
 # The full version, including alpha/beta/rc tags.
-release = read_version()
+release = version
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

esrally/__init__.py

@@ -19,9 +19,7 @@
 import sys
 import urllib
 
-import pkg_resources
-
-__version__ = pkg_resources.require("esrally")[0].version
+from ._version import __version__
 
 # Allow an alternative program name be set in case Rally is invoked a wrapper script
 PROGRAM_NAME = os.getenv("RALLY_ALTERNATIVE_BINARY_NAME", os.path.basename(sys.argv[0]))

esrally/_version.py

@@ -0,0 +1 @@
+__version__ = "2.3.1.dev0"

esrally/version.py

@@ -18,13 +18,10 @@
 import re
 from importlib import resources
 
-import pkg_resources
-
 from esrally import paths
+from esrally._version import __version__
 from esrally.utils import git, io
 
-__version__ = pkg_resources.require("esrally")[0].version
-
 __RALLY_VERSION_PATTERN = re.compile(r"^(\d+)(?:\.(\d+))?(?:\.(\d+))?(?:.(.+))?$")
 
 

release.sh

@@ -59,7 +59,7 @@ git commit -a -m "Update changelog for Rally release $RELEASE_VERSION"
 
 # * Update version in `setup.py` and `docs/conf.py`
 echo "Updating release version number"
-echo "$RELEASE_VERSION" > version.txt
+printf '__version__ = "%s"\n' $RELEASE_VERSION > esrally/_version.py
 git commit -a -m "Bump version to $RELEASE_VERSION"
 
 # --upgrade is required for virtualenv
@@ -83,7 +83,7 @@ git tag -s "${RELEASE_VERSION}" -m "Rally release $RELEASE_VERSION"
 git push --tags
 
 # Update version to next dev version
-echo "$NEXT_RELEASE" > version.txt
+printf '__version__ = "%s"\n' $NEXT_RELEASE > esrally/_version.py
 
 # Install locally for development
 python3 setup.py develop --upgrade

setup.py

@@ -16,6 +16,7 @@
 # under the License.
 
 from os.path import join, dirname
+import re
 
 try:
     from setuptools import setup, find_packages
@@ -29,10 +30,8 @@ def str_from_file(name):
         return f.read().strip()
 
 
-raw_version = str_from_file("version.txt")
-VERSION = raw_version.split(".")
-__version__ = VERSION
-__versionstr__ = raw_version
+raw_version = str_from_file("esrally/_version.py")
+version = re.match(r'__version__ = "(.+)"', raw_version).group(1)
 
 long_description = str_from_file("README.rst")
 
@@ -122,7 +121,7 @@ def str_from_file(name):
 setup(name="esrally",
       maintainer="Daniel Mitterdorfer",
       maintainer_email="[email protected]",
-      version=__versionstr__,
+      version=version,
       description="Macrobenchmarking framework for Elasticsearch",
       long_description=long_description,
       url="https://github.com/elastic/rally",