pyrelukko 0.6.1__tar.gz → 0.8.0__tar.gz

pyrelukko-0.8.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.3
+Name: pyrelukko
+Version: 0.8.0
+Summary: Relukko client.
+Author-email: Reto Zingg <g.d0b3rm4n@gmail.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: requests >=2.32.3
+Requires-Dist: websockets >= 14.1
+Project-URL: Homepage, https://gitlab.com/relukko/pyrelukko
+Project-URL: Issues, https://gitlab.com/relukko/pyrelukko/-/issues
+
+# PyRelukko
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pyrelukko.svg)](https://pypi.org/project/pyrelukko)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyrelukko.svg)](https://pypi.org/project/pyrelukko)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fgitlab.com%2Frelukko%2Fpyrelukko%2F-%2Fraw%2Fmaster%2Fpyproject.toml%3Fref_type%3Dheads)
+![Gitlab Pipeline Status](https://img.shields.io/gitlab/pipeline-status/relukko%2Fpyrelukko?branch=master)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/pyrelukko)
+![PyPI - License](https://img.shields.io/pypi/l/pyrelukko)
+![GitLab License](https://img.shields.io/gitlab/license/relukko%2Fpyrelukko)
+![PyPI - Format](https://img.shields.io/pypi/format/pyrelukko)
+![PyPI - Status](https://img.shields.io/pypi/status/pyrelukko)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/pyrelukko)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/pyrelukko)
+![GitLab Stars](https://img.shields.io/gitlab/stars/relukko%2Fpyrelukko)
+![GitLab Forks](https://img.shields.io/gitlab/forks/relukko%2Fpyrelukko)
+-----
+
+Python library to access a
+[Relukko back-end](https://gitlab.com/relukko/relukko).
+

pyrelukko-0.8.0/README.md

@@ -0,0 +1,19 @@
+# PyRelukko
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pyrelukko.svg)](https://pypi.org/project/pyrelukko)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyrelukko.svg)](https://pypi.org/project/pyrelukko)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fgitlab.com%2Frelukko%2Fpyrelukko%2F-%2Fraw%2Fmaster%2Fpyproject.toml%3Fref_type%3Dheads)
+![Gitlab Pipeline Status](https://img.shields.io/gitlab/pipeline-status/relukko%2Fpyrelukko?branch=master)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/pyrelukko)
+![PyPI - License](https://img.shields.io/pypi/l/pyrelukko)
+![GitLab License](https://img.shields.io/gitlab/license/relukko%2Fpyrelukko)
+![PyPI - Format](https://img.shields.io/pypi/format/pyrelukko)
+![PyPI - Status](https://img.shields.io/pypi/status/pyrelukko)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/pyrelukko)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/pyrelukko)
+![GitLab Stars](https://img.shields.io/gitlab/stars/relukko%2Fpyrelukko)
+![GitLab Forks](https://img.shields.io/gitlab/forks/relukko%2Fpyrelukko)
+-----
+
+Python library to access a
+[Relukko back-end](https://gitlab.com/relukko/relukko).

{pyrelukko-0.6.1 → pyrelukko-0.8.0}/cicd/run_pytest.sh

@@ -2,7 +2,7 @@
 
 # Main script execution
 main() {
-    tox run --skip-missing-interpreters --skip-env 'pylint|shellcheck|docs'
+    tox run --skip-missing-interpreters --skip-env 'pylint|shellcheck|docs|publish'
 }
 
 # Execute the main function

{pyrelukko-0.6.1 → pyrelukko-0.8.0}/pyproject.toml

@@ -16,7 +16,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 dynamic = ["version", "description"]
 dependencies = [
     "requests >=2.32.3",
@@ -43,7 +43,7 @@ publish = [
 ]
 
 [tool.flit.sdist]
-exclude = [".gitignore", "demo.py"]
+exclude = [".gitignore", "demo.py", "utils"]
 
 [project.urls]
 Homepage = "https://gitlab.com/relukko/pyrelukko"

pyrelukko-0.6.1/src/pyrelukko/retry.py → pyrelukko-0.8.0/src/pyrelukko/decorators.py

@@ -1,6 +1,7 @@
 """
 TBD
 """
+import os
 import time
 from functools import wraps
 
@@ -43,3 +44,38 @@ def retry(logger, exceptions, tries=4, delay=5,
             return f(*args, **kwargs)
         return f_retry  # true decorator
     return deco_retry
+
+
+SKIP_RELUKKO = {
+    "id": "00000000-0000-0000-0000-000000000000",
+    "lock_name": "WE TRUST YOU",
+    "creator": "Dummy Dummy",
+    "ip": "0.0.0.0",
+    "expires_at": "1970-01-01T00:00:00Z",
+    "created_at": "1970-01-01T00:00:00Z",
+    "updated_at": "1970-01-01T00:00:00Z"
+}
+
+
+def skip_http_call():
+    """
+    Decorator for pyrlukko methods.
+
+    It skips the actual method if the environment variable
+    `RELUKKO_TRUST_ME_IT_IS_LOCKED` is set and returns instead a static lock
+    dictionary or list with the same static lock dictionary.
+
+    Useful when developing and the resource is for sure locked, e.g through the
+    Web UI.
+    """
+    def deco_skip(f):
+
+        @wraps(f)
+        def f_skip(*args, **kwargs):
+            if os.environ.get('RELUKKO_TRUST_ME_IT_IS_LOCKED'):
+                if f.__name__ == "get_locks":
+                    return [ SKIP_RELUKKO ]
+                return SKIP_RELUKKO
+            return f(*args, **kwargs)
+        return f_skip  # true decorator
+    return deco_skip

{pyrelukko-0.6.1 → pyrelukko-0.8.0}/src/pyrelukko/pyrelukko.py

@@ -18,7 +18,7 @@ from urllib3.util.retry import Retry
 from websockets import ConnectionClosed as WsConnectionClosed
 from websockets.asyncio.client import connect as ws_connect
 
-from .retry import retry
+from .decorators import retry, skip_http_call
 
 SSL_KWARGS = [
     'check_hostname',
@@ -300,6 +300,7 @@ class RelukkoClient:
 
         return _do_request()
 
+    @skip_http_call()
     def acquire_relukko(self, lock_name, creator, max_run_time):
         """
         TBD
@@ -336,6 +337,7 @@ class RelukkoClient:
             return thread_store[0]
         return None
 
+    @skip_http_call()
     def get_lock(self, lock_id: str) -> Dict:
         """
         TBD
@@ -343,6 +345,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}"
         return self._make_request(url, "GET")
 
+    @skip_http_call()
     def get_locks(self)  -> List:
         """
         TBD
@@ -350,6 +353,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/"
         return self._make_request(url, "GET")
 
+    @skip_http_call()
     def update_relukko(
             self, lock_id: str, creator: str=None, expires_at: datetime=None):
         """
@@ -367,6 +371,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}"
         return self._make_request(url, "PUT", payload)
 
+    @skip_http_call()
     def delete_relukko(self, lock_id: str):
         """
         TBD
@@ -374,6 +379,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}"
         return self._make_request(url, "DELETE")
 
+    @skip_http_call()
     def keep_relukko_alive(self, lock_id: str):
         """
         TBD
@@ -381,6 +387,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}/keep_alive"
         return self._make_request(url, "GET")
 
+    @skip_http_call()
     def keep_relukko_alive_put(self, lock_id: str, seconds: int):
         """
         TBD
@@ -391,6 +398,7 @@ class RelukkoClient:
         }
         return self._make_request(url, "PUT", payload)
 
+    @skip_http_call()
     def add_to_expires_at_time(self, lock_id: str):
         """
         TBD
@@ -398,6 +406,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}/add_to_expire_at"
         return self._make_request(url, "GET")
 
+    @skip_http_call()
     def add_to_expires_at_time_put(self, lock_id: str, seconds: int):
         """
         TBD

{pyrelukko-0.6.1 → pyrelukko-0.8.0}/src/pyrelukko/testcontainers.py

@@ -14,6 +14,7 @@ def relukko_backend():
                     base_url=backend.get_api_url(), api_key="somekey")
                 yield relukko, backend
 """
+import os
 import socket
 
 from testcontainers.core.network import Network
@@ -24,10 +25,12 @@ from testcontainers.postgres import PostgresContainer
 
 class RelukkoContainer(ServerContainer):
     def __init__(self, net: Network,
-                 image="registry.gitlab.com/relukko/relukko:latest", db_url=None):
+                 image="registry.gitlab.com/relukko/relukko:latest",
+                 db_url=None):
+        container_image = os.environ.get('CI_RELUKKO_CONTAINER_IMAGE') or image
         self.db_url = db_url
         self.net = net
-        super(RelukkoContainer, self).__init__(image=image, port=3000)
+        super(RelukkoContainer, self).__init__(image=container_image, port=3000)
 
     def _configure(self):
         self.with_env("DATABASE_URL", self.db_url)

{pyrelukko-0.6.1 → pyrelukko-0.8.0}/src/pyrelukko/version.py

@@ -1,2 +1,2 @@
 # pylint: disable=all
-__version__ = "0.6.1"
+__version__ = "0.8.0"

{pyrelukko-0.6.1 → pyrelukko-0.8.0}/tests/conftest.py

@@ -77,3 +77,9 @@ def tls_listener():
 
     keep_running.clear()
     thread.join()
+
+@pytest.fixture(scope="function")
+def mock_env_relukko_skip(monkeypatch):
+    monkeypatch.setenv("RELUKKO_TRUST_ME_IT_IS_LOCKED", "yes")
+    yield
+    monkeypatch.delenv("RELUKKO_TRUST_ME_IT_IS_LOCKED", raising=True)

{pyrelukko-0.6.1 → pyrelukko-0.8.0}/tests/test_relukko.py

@@ -15,7 +15,7 @@ from urllib3.util import parse_url
 
 from pyrelukko import RelukkoClient
 from pyrelukko.pyrelukko import RelukkoDoRetry
-from pyrelukko.retry import retry
+from pyrelukko.decorators import retry
 
 
 SCRIPT_DIR = Path(__file__).parent.absolute()

pyrelukko-0.8.0/tests/test_skip_relukko.py

@@ -0,0 +1,48 @@
+import logging
+from datetime import datetime
+
+from pyrelukko import RelukkoClient
+from pyrelukko.decorators import SKIP_RELUKKO
+
+logger = logging.getLogger(__name__)
+exp_expires_at = datetime.fromisoformat(SKIP_RELUKKO["expires_at"])
+
+
+def test_skip_life_cycle(mock_env_relukko_skip):
+    assert mock_env_relukko_skip is None
+    relukko = RelukkoClient(base_url="http://relukko", api_key="abc")
+
+    skipped = relukko.acquire_relukko(
+        "SKIP_THIS", creator="skipper", max_run_time=5)
+    assert skipped == SKIP_RELUKKO
+
+    lock = relukko.get_lock(
+        "00000000-0000-0000-0000-000000000000")
+    assert lock == SKIP_RELUKKO
+
+    locks = relukko.get_locks()
+    assert locks == [ SKIP_RELUKKO ]
+
+    lock = relukko.update_relukko(
+        "00000000-0000-0000-0000-000000000000", creator="Skipper")
+    assert lock == SKIP_RELUKKO
+
+    lock = relukko.delete_relukko(
+        "00000000-0000-0000-0000-000000000000")
+    assert lock == SKIP_RELUKKO
+
+    lock = relukko.keep_relukko_alive(
+        "00000000-0000-0000-0000-000000000000")
+    assert lock == SKIP_RELUKKO
+
+    lock = relukko.keep_relukko_alive_put(
+        "00000000-0000-0000-0000-000000000000", 5)
+    assert lock == SKIP_RELUKKO
+
+    lock = relukko.add_to_expires_at_time(
+        "00000000-0000-0000-0000-000000000000")
+    assert lock == SKIP_RELUKKO
+
+    lock = relukko.add_to_expires_at_time_put(
+        "00000000-0000-0000-0000-000000000000", 5)
+    assert lock == SKIP_RELUKKO

pyrelukko-0.6.1/PKG-INFO

@@ -1,24 +0,0 @@
-Metadata-Version: 2.3
-Name: pyrelukko
-Version: 0.6.1
-Summary: Relukko client.
-Author-email: Reto Zingg <g.d0b3rm4n@gmail.com>
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: requests >=2.32.3
-Requires-Dist: websockets >= 14.1
-Project-URL: Homepage, https://gitlab.com/relukko/pyrelukko
-Project-URL: Issues, https://gitlab.com/relukko/pyrelukko/-/issues
-
-# PyRelukko
-Python library to access a
-[Relukko back-end](https://gitlab.com/relukko/relukko).
-

pyrelukko-0.6.1/README.md

@@ -1,3 +0,0 @@
-# PyRelukko
-Python library to access a
-[Relukko back-end](https://gitlab.com/relukko/relukko).