Merge #409

409: Add package version r=alallema a=brunoocasali

- Add a way to load the package version programmatically. 
- Change CONTRIBUTING.md and check-release scripts, since there is a new way to update the package version of the python SDK. 

Co-authored-by: Bruno Casali <[email protected]>

Author: bors[bot]

.github/scripts/check-release.sh

@@ -2,7 +2,7 @@
 
 # Checking if current tag matches the package version
 current_tag=$(echo $GITHUB_REF | tr -d 'refs/tags/v')
-file_tag=$(grep 'version=' setup.py | cut -d '=' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
+file_tag=$(grep '__version__ =' meilisearch/version.py | cut -d '=' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
 if [ "$current_tag" != "$file_tag" ]; then
   echo "Error: the current tag does not match the version in package file(s)."
   echo "$current_tag vs $file_tag"

CONTRIBUTING.md

@@ -114,10 +114,10 @@ _[Read more about this](https://github.com/meilisearch/integration-guides/blob/m
 
 ⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
 
-Make a PR modifying the file [`setup.py`](/setup.py) with the right version.
+Make a PR modifying the file [`meilisearch/version.py`](/meilisearch/version.py) with the right version.
 
 ```python
-version="X.X.X"
+__version__ = "X.X.X"
 ```
 
 Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-python/releases): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommandations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.

meilisearch/version.py

@@ -0,0 +1,6 @@
+__version__ = "0.18.0"
+
+def qualified_version() -> str:
+    """Get the qualified version of this module."""
+
+    return f"Meilisearch Python (v{__version__})"

setup.py

@@ -1,4 +1,5 @@
 from setuptools import setup, find_packages
+from meilisearch.version import __version__
 
 with open("README.md", "r", encoding="utf8") as fh:
     long_description = fh.read()
@@ -8,7 +9,7 @@
         "requests"
     ],
     name="meilisearch",
-    version="0.18.0",
+    version=__version__,
     author="Charlotte Vermandel",
     author_email="[email protected]",
     description="The python client for Meilisearch API.",

tests/client/test_version.py

@@ -0,0 +1,12 @@
+# pylint: disable=invalid-name
+
+import re
+
+from meilisearch.version import __version__, qualified_version
+
+
+def test_get_version():
+    assert re.match(r'^(\d+\.)?(\d+\.)?(\*|\d+)$', __version__)
+
+def test_get_qualified_version():
+    assert qualified_version() == f"Meilisearch Python (v{__version__})"