setup: use git version instead of hardcoded one

setuptool_scm [1] package is a recommended way to set package version
with git [2]. Version 6.4.2 was chosen due to Python 3.6 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.

If a developer would clone this repo, version of the package would be
'dev' until he runs `make install`. If they have some old `tarantool`
version installed globally and does not use virtual environment, its
version would be displayed instead.

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,10 +33,8 @@ jobs:
         with:
           python-version: 3.7
 
-      - name: Install connector requirements
-        run: pip install -r requirements.txt
-
       - name: Install test requirements
         run: pip install -r requirements-test.txt
 
-      - run: make test
+      - name: Install the package and run tests
+        run: make test

.github/workflows/testing.yml

@@ -79,13 +79,10 @@ 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 test requirements
         run: pip install -r requirements-test.txt
 
-      - name: Run tests
+      - name: Install the package and run tests
         run: make test
 
   run_tests_ee_linux:
@@ -135,13 +132,10 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
 
-      - name: Install package requirements
-        run: pip install -r requirements.txt
-
       - name: Install test requirements
         run: pip install -r requirements-test.txt
 
-      - name: Run tests
+      - name: Install the package and run tests
         run: |
           source tarantool-enterprise/env.sh
           make test
@@ -232,9 +226,6 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
 
-      - name: Install connector requirements
-        run: pip install -r requirements.txt
-
       - name: Install test requirements
         run: pip install -r requirements-test.txt
 
@@ -265,7 +256,7 @@ jobs:
           touch tarantool.pid
           echo $TNT_PID > ./tarantool.pid
 
-      - name: Run tests
+      - name: Install the package and run tests
         env:
           REMOTE_TARANTOOL_HOST: localhost
           REMOTE_TARANTOOL_CONSOLE_PORT: 3302

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).

Makefile

@@ -1,11 +1,11 @@
 .PHONY: install test
 install:
 	python setup.py install
-test:
+test: install
 	python setup.py test
 testdata:
 	cd ./test/data/; ./generate.sh
-coverage:
+coverage: install
 	python -m coverage run -p --source=. setup.py test
 cov-html:
 	python -m coverage html -i
@@ -17,7 +17,7 @@ dist-upload:
 	python setup.py sdist --format=gztar,bztar,zip upload
 dist-upload-2:
 	python setup.py sdist --format=ztar upload
-docs:
+docs: install
 	python setup.py build_sphinx
 docs-upload: docs
 	python setup.py upload_sphinx

README.rst

@@ -84,6 +84,15 @@ This driver is synchronous, so connection mustn't be shared between threads/proc
 If you're looking for an asynchronous Python driver based on ``asyncio``,
 consider using `asynctnt`_ . See also the `feature comparison table`_.
 
+Local development
+^^^^^^^^^^^^^^^^^
+
+If you want to work with cloned repo, first you must run
+
+.. code-block:: bash
+
+    $ make install
+
 Run tests
 ^^^^^^^^^
 

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):
             return f.read().splitlines()
     raise RuntimeError("Unable to get dependencies from file " + file)
 
-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=find_packages("."),
     package_dir={"tarantool": "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==6.4.2',
+    ],
     python_requires='>=3',
 )

tarantool/__init__.py

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