Merge pull request #10 from davidlatwe/auto-upgrade

Auto upgrade

Author: davidlatwe

.github/workflows/pypi-cli.yml

@@ -0,0 +1,32 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package (cli)
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        cd cli
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

README.md

@@ -117,3 +117,27 @@ list containers
 ```
 $ rezup list
 ```
+
+
+### Auto Upgrade
+
+Updating package that has running console scripts can be error prone. We need to separate API package and CLI scripts as two different PyPI project (`rezup-api` & `rezup`), so we can safely upgrade only the package part while the console script is running.
+
+Both projects will be released together under same version, so that one could still upgrading the API part via upgrading CLI. As long as console script is not in use.
+
+```
+pip install --upgrade rezup
+```
+
+The upgrade checking process will be triggered immediately when calling `rezup` in console, except version querying or last upgrade check is done not long before `REZUP_UPGRADE_PAUSE` period ends. If upgrade is needed and completed, session will be restarted with previous command.
+
+
+### Environment Variables
+
+|Name|Description|
+| --- | --- |
+|REZUP_ROOT_LOCAL|Local root of all containers and metadata, default is `~/.rezup`|
+|REZUP_ROOT_REMOTE|Remote root of all containers but only recipe file|
+|REZUP_NO_UPGRADE|Disable auto upgrade if set (any value is valid except empty string)|
+|REZUP_UPGRADE_PAUSE|Pause version check after last upgrade, default 86400 (1 day, in second)|
+|REZUP_UPGRADE_SOURCE|Local source repository for upgrade, check from PyPI if not set.|

cli/README.md

@@ -0,0 +1,6 @@
+# rezup (cli)
+
+This project is for distributing console entry points of [rezup-api](https://pypi.org/project/rezup-api), please visit there for documentation.
+
+Why not use `extras` specification ?
+See [pypa/pip#9726](https://github.com/pypa/pip/issues/9726)

cli/requirements.txt

@@ -0,0 +1 @@
+rezup-api>=1.4

cli/setup.cfg

@@ -0,0 +1,34 @@
+[metadata]
+name = rezup
+version = attr: version.__version__
+description = Rez launching environment manager
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/davidlatwe/rezup
+author = davidlatwe
+author_email = davidlatwe@gmail.com
+maintainer = davidlatwe
+maintainer_email = davidlatwe@gmail.com
+license = GPLv3
+license_file = LICENSE
+platforms = any
+project_urls =
+    Source=https://github.com/davidlatwe/rezup
+    Tracker=https://github.com/davidlatwe/rezup/issues
+
+[options]
+zip_safe = true
+python_requires = >=3, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
+install_requires =
+    rezup-api>=1.4
+packages = find:
+
+[options.entry_points]
+console_scripts =
+    rezup=rezup.cli:run
+
+[sdist]
+formats = gztar
+
+[bdist_wheel]
+universal = true

cli/setup.py

@@ -0,0 +1,3 @@
+
+from setuptools import setup
+setup()

cli/version.py

@@ -0,0 +1,6 @@
+
+g = {"__version__": None}
+with open("../src/rezup/_version.py") as f:
+    exec(f.read(), g)
+
+__version__ = g["__version__"]

requirements.txt

@@ -2,3 +2,4 @@ distlib>=0.3.1,<1
 virtualenv>=20.4.4,<21
 shellingham>=1.4.0,<2
 python-dotenv>=0.17,<1
+requests==2.24.0

setup.cfg

@@ -1,5 +1,5 @@
 [metadata]
-name = rezup
+name = rezup-api
 version = attr: rezup._version.__version__
 description = Rez launching environment manager
 long_description = file: README.md
@@ -41,6 +41,7 @@ install_requires =
     virtualenv>=20.4.4,<21
     shellingham>=1.4.0,<2
     python-dotenv>=0.17,<1
+    requests==2.24.0
 packages = find:
 package_dir =
     = src
@@ -51,10 +52,6 @@ where = src
 exclude =
     tests
 
-[options.entry_points]
-console_scripts =
-    rezup=rezup.cli:run
-
 [options.package_data]
 rezup = rezup.toml
 rezup.launch = up.*

src/rezup/_vendor/version.py

@@ -0,0 +1,146 @@
+from __future__ import print_function
+import sys
+import re
+
+if sys.version_info >= (3, 0):
+    from itertools import zip_longest as izip_longest
+else:
+    from itertools import izip_longest
+
+
+class _Comparable(object):
+
+    """Rich comparison operators based on __lt__ and __eq__."""
+
+    __gt__ = lambda self, other: not self < other and not self == other
+    __le__ = lambda self, other: self < other or self == other
+    __ne__ = lambda self, other: not self == other
+    __ge__ = lambda self, other: self > other or self == other
+
+
+class VersionError(Exception):
+    pass
+
+
+_re = re.compile('^'
+                 '(\\d+)\\.(\\d+)\\.(\\d+)'  # minor, major, patch
+                 '(-[0-9A-Za-z-.]+)?'  # pre-release
+                 '(\\+[0-9A-Za-z-.]+)?'  # build
+                 '$')
+
+
+class _Seq(_Comparable):
+
+    """Sequence of identifies that could be compared according to semver."""
+
+    def __init__(self, seq):
+        self.seq = seq
+
+    def __lt__(self, other):
+        assert set([int, str]) >= set(map(type, self.seq))
+        for s, o in izip_longest(self.seq, other.seq):
+            assert not (s is None and o is None)
+            if s is None or o is None:
+                return bool(s is None)
+            if type(s) is int and type(o) is int:
+                if s < o:
+                    return True
+            elif type(s) is int or type(o) is int:
+                return type(s) is int
+            elif s != o:
+                return s < o
+
+    def __eq__(self, other):
+        return self.seq == other.seq
+
+
+def _try_int(s):
+    assert type(s) is str
+    try:
+        return int(s)
+    except ValueError:
+        return s
+
+
+def _make_group(g):
+    return [] if g is None else list(map(_try_int, g[1:].split('.')))
+
+
+class Version(_Comparable):
+
+    def __init__(self, version):
+        match = _re.match(version)
+        if not match:
+            raise VersionError('invalid version %r' % version)
+        self.major, self.minor, self.patch = map(int, match.groups()[:3])
+        self.pre_release = _make_group(match.group(4))
+        self.build = _make_group(match.group(5))
+
+    def __str__(self):
+        s = '.'.join(str(s) for s in self._mmp())
+        if self.pre_release:
+            s += '-%s' % '.'.join(str(s) for s in self.pre_release)
+        if self.build:
+            s += '+%s' % '.'.join(str(s) for s in self.build)
+        return s
+
+    def __repr__(self):
+        return '%s(%r)' % (self.__class__.__name__, self.__str__())
+
+    def _mmp(self):
+        return [self.major, self.minor, self.patch]
+
+    def __lt__(self, other):
+        self._assume_to_be_comparable(other)
+        if self._mmp() == other._mmp():
+            if self.pre_release == other.pre_release:
+                if self.build == other.build:
+                    return False
+                elif self.build and other.build:
+                    return _Seq(self.build) < _Seq(other.build)
+                elif self.build or other.build:
+                    return bool(other.build)
+                assert not 'reachable'
+            elif self.pre_release and other.pre_release:
+                return _Seq(self.pre_release) < _Seq(other.pre_release)
+            elif self.pre_release or other.pre_release:
+                return bool(self.pre_release)
+            assert not 'reachable'
+        return self._mmp() < other._mmp()
+
+    def __eq__(self, other):
+        self._assume_to_be_comparable(other)
+        return all([self._mmp() == other._mmp(),
+                    self.build == other.build,
+                    self.pre_release == other.pre_release])
+
+    def _assume_to_be_comparable(self, other):
+        if not isinstance(other, Version):
+            raise TypeError('cannot compare `%r` with `%r`' % (self, other))
+
+
+__version__ = str(Version('0.1.2'))
+
+
+# Copyright (c) 2014 Vladimir Keleshev, <vladimir@keleshev.com>
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.

src/rezup/_version.py

@@ -1,4 +1,4 @@
-__version__ = "1.3.1"
+__version__ = "1.4.0"
 
 
 def package_info():

src/rezup/cli.py

@@ -9,6 +9,10 @@ def run():
     parser = argparse.ArgumentParser("rezup")
     parser.add_argument("-V", "--version", action="store_true",
                         help="show version and exit.")
+    parser.add_argument("--check-latest", action="store_true",
+                        help="show version of latest rezup(api) and exit.")
+    parser.add_argument("--no-upgrade", action="store_true",
+                        help="disable auto upgrade check.")
 
     subparsers = parser.add_subparsers(dest="cmd", metavar="COMMAND")
 
@@ -48,6 +52,14 @@ def run():
         from rezup._version import print_info
         sys.exit(print_info())
 
+    if opts.check_latest:
+        from .upgrade import show_latest
+        sys.exit(show_latest())
+
+    if not (opts.no_upgrade or os.getenv("REZUP_NO_UPGRADE")):
+        from .upgrade import auto_upgrade
+        auto_upgrade()
+
     if opts.cmd == "use":
         cmd_use(opts.name, make=opts.make, job=opts.do)