feat(helper): add version check for client and server

client/clip_client/__init__.py

@@ -1,3 +1,10 @@
 __version__ = '0.3.1'
 
+import os
+
 from .client import Client
+
+if 'NO_VERSION_CHECK' not in os.environ:
+    from .helper import is_latest_version
+
+    is_latest_version(github_repo='clip-as-service')

client/clip_client/helper.py

@@ -0,0 +1,56 @@
+import json
+import sys
+import threading
+from distutils.version import LooseVersion
+from urllib.request import Request, urlopen
+
+import pkg_resources
+from rich import print
+from rich.panel import Panel
+
+
+def _version_check(package: str = None, github_repo: str = None):
+    try:
+
+        if not package:
+            package = vars(sys.modules[__name__])['__package__']
+        if not github_repo:
+            github_repo = package
+
+        cur_ver = LooseVersion(pkg_resources.get_distribution(package).version)
+        req = Request(
+            f'https://pypi.python.org/pypi/{package}/json',
+            headers={'User-Agent': 'Mozilla/5.0'},
+        )
+        with urlopen(
+            req, timeout=5
+        ) as resp:  # 'with' is important to close the resource after use
+            j = json.load(resp)
+            releases = j.get('releases', {})
+            latest_release_ver = list(
+                sorted(LooseVersion(v) for v in releases.keys() if '.dev' not in v)
+            )[-1]
+            if cur_ver < latest_release_ver:
+                print(
+                    Panel(
+                        f'You are using [b]{package} {cur_ver}[/b], but [bold green]{latest_release_ver}[/] is available. '
+                        f'You may upgrade it via [b]pip install -U {package}[/b]. [link=https://github.com/jina-ai/{github_repo}/blob/main/CHANGELOG.md]Read Changelog here[/link].',
+                        title=':new: New version available!',
+                        width=50,
+                    )
+                )
+    except Exception:
+        # no network, too slow, PyPi is down
+        pass
+
+
+def is_latest_version(package: str = None, github_repo: str = None) -> None:
+    """Check if there is a latest version from Pypi, set env `NO_VERSION_CHECK` to disable it.
+
+    :param package: package name if none auto-detected
+    :param github_repo: repo name that contains CHANGELOG if none then the same as package name
+    """
+
+    threading.Thread(
+        target=_version_check, daemon=True, args=(package, github_repo)
+    ).start()

server/clip_server/__main__.py

@@ -1,9 +1,15 @@
-import sys
-import os
 import inspect
-from jina import Flow
+import os
+import sys
 
 if __name__ == '__main__':
+    if 'NO_VERSION_CHECK' not in os.environ:
+        from .helper import is_latest_version
+
+        is_latest_version(github_repo='clip-as-service')
+
+    from jina import Flow
+
     f = Flow.load_config(
         'torch-flow.yml' if len(sys.argv) == 1 else sys.argv[1],
         extra_search_paths=[os.path.dirname(inspect.getfile(inspect.currentframe()))],

server/clip_server/helper.py

@@ -1,5 +1,13 @@
+import json
 import os
 import sys
+import threading
+from distutils.version import LooseVersion
+from urllib.request import Request, urlopen
+
+import pkg_resources
+from rich import print
+from rich.panel import Panel
 
 __resources_path__ = os.path.join(
     os.path.dirname(
@@ -9,3 +17,50 @@
     ),
     'resources',
 )
+
+
+def _version_check(package: str = None, github_repo: str = None):
+    try:
+
+        if not package:
+            package = vars(sys.modules[__name__])['__package__']
+        if not github_repo:
+            github_repo = package
+
+        cur_ver = LooseVersion(pkg_resources.get_distribution(package).version)
+        req = Request(
+            f'https://pypi.python.org/pypi/{package}/json',
+            headers={'User-Agent': 'Mozilla/5.0'},
+        )
+        with urlopen(
+            req, timeout=5
+        ) as resp:  # 'with' is important to close the resource after use
+            j = json.load(resp)
+            releases = j.get('releases', {})
+            latest_release_ver = list(
+                sorted(LooseVersion(v) for v in releases.keys() if '.dev' not in v)
+            )[-1]
+            if cur_ver < latest_release_ver:
+                print(
+                    Panel(
+                        f'You are using [b]{package} {cur_ver}[/b], but [bold green]{latest_release_ver}[/] is available. '
+                        f'You may upgrade it via [b]pip install -U {package}[/b]. [link=https://github.com/jina-ai/{github_repo}/blob/main/CHANGELOG.md]Read Changelog here[/link].',
+                        title=':new: New version available!',
+                        width=50,
+                    )
+                )
+    except Exception:
+        # no network, too slow, PyPi is down
+        pass
+
+
+def is_latest_version(package: str = None, github_repo: str = None) -> None:
+    """Check if there is a latest version from Pypi, set env `NO_VERSION_CHECK` to disable it.
+
+    :param package: package name if none auto-detected
+    :param github_repo: repo name that contains CHANGELOG if none then the same as package name
+    """
+
+    threading.Thread(
+        target=_version_check, daemon=True, args=(package, github_repo)
+    ).start()