setup: use git version instead of hardcoded one

setuptool_scm [1] package is a recommended way to set package version
with git [2]. Version 5.0.2 was chosen due to Python 3.5 support,
latest version 7.0.5 supports only Python 3.7+.

Package version is displayed in documentation, so after this patch
documentation for master branch won't be confused with the last tagged
one.

The drawback is that after this patch, any developer should run
`make install` before any module interactions (like running tests).

1. https://pypi.org/project/setuptools-scm/
2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/

Part of #238

Author: DifferentialOrange

.github/workflows/reusable_testing.yml

@@ -33,8 +33,8 @@ jobs:
         with:
           python-version: 3.7
 
-      - name: Install connector requirements
-        run: pip install -r requirements.txt
+      - name: Install the package
+        run: make install
 
       - name: Install test requirements
         run: pip install -r requirements-test.txt

.github/workflows/testing.yml

@@ -79,8 +79,8 @@ jobs:
           pip install ${{ matrix.msgpack-deps }}
           sed -i -e "s/^msgpack.*$/${{ matrix.msgpack-deps }}/" requirements.txt
 
-      - name: Install package requirements
-        run: pip install -r requirements.txt
+      - name: Install the package
+        run: make install
 
       - name: Install test requirements
         run: pip install -r requirements-test.txt
@@ -135,8 +135,8 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
 
-      - name: Install package requirements
-        run: pip install -r requirements.txt
+      - name: Install the package
+        run: make install
 
       - name: Install test requirements
         run: pip install -r requirements-test.txt
@@ -179,8 +179,8 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
 
-      - name: Install connector requirements
-        run: pip install -r requirements.txt
+      - name: Install the package
+        run: make install
 
       - name: Install test requirements
         run: pip install -r requirements-test.txt

CHANGELOG.md

@@ -141,6 +141,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Change documentation HTML theme (#67).
 - Update API documentation strings (#67).
 - Update documentation index, quick start and guide pages (#67).
+- Use git version to set package version (#238).
 
 ### Fixed
 - Package build (#238).

README.rst

@@ -91,7 +91,8 @@ On Linux:
 
 .. code-block:: bash
 
-   $ make test
+    $ make install
+    $ make test
 
 On Windows:
 
@@ -103,7 +104,8 @@ On Windows:
 * Set the following environment variables:
   * ``REMOTE_TARANTOOL_HOST=...``,
   * ``REMOTE_TARANTOOL_CONSOLE_PORT=3302``.
-* Run ``make test``.
+* Install the package: ``make install``.
+* Run tests: ``make test``.
 
 Build docs
 ^^^^^^^^^^
@@ -114,7 +116,14 @@ To build documentation, first you must install its build requirements:
 
     $ pip install -r requirements-doc.txt
 
-Then run
+To build with valid version, `tarantool` package must be installed before
+documentation build.
+
+.. code-block:: bash
+
+    $ make install
+
+Build documentation the documentation with
 
 .. code-block:: bash
 

requirements.txt

@@ -1,3 +1,4 @@
 msgpack>=1.0.4
 pandas
 pytz
+importlib-metadata >= 1.0 ; python_version < '3.8'

setup.py

@@ -59,21 +59,12 @@ def get_dependencies(file):
             result = f.read().splitlines()
     return result
 
-def find_version(*file_paths):
-    version_file = read(*file_paths)
-    version_match = re.search(r"""^__version__\s*=\s*(['"])(.+)\1""",
-                              version_file, re.M)
-    if version_match:
-        return version_match.group(2)
-    raise RuntimeError("Unable to find version string.")
-
-
 setup(
     name="tarantool",
     packages=["tarantool"],
     package_dir={"tarantool": os.path.join("tarantool")},
     include_package_data=True,
-    version=find_version('tarantool', '__init__.py'),
+    use_scm_version=True,
     platforms=["all"],
     author="tarantool-python AUTHORS",
     author_email="[email protected]",
@@ -92,5 +83,8 @@ def find_version(*file_paths):
     cmdclass=cmdclass,
     command_options=command_options,
     install_requires=get_dependencies('requirements.txt'),
+    setup_requires=[
+        'setuptools_scm==5.0.2',
+    ],
     python_requires='>=3',
 )

tarantool/__init__.py

@@ -40,7 +40,12 @@
     Interval,
 )
 
-__version__ = "0.9.0"
+if sys.version_info >= (3, 8):
+    from importlib import metadata
+else:
+    import importlib_metadata as metadata
+
+__version__ = metadata.version('tarantool')
 
 
 def connect(host="localhost", port=33013, user=None, password=None,