logikal-utils 1.0.0__tar.gz

logikal-utils-1.0.0/.copier-answers.yml

@@ -0,0 +1,24 @@
+###################################################################################################
+##
+##  DO NOT EDIT THIS FILE.
+##  This is an answers file generated by Copier.
+##
+###################################################################################################
+_commit: v1.0.2
+_src_path: git@github.com:logikal-io/python-package-template.git
+audience: Developers
+classifiers:
+- 'Topic :: Software Development'
+cloud: false
+description: Common Python utilities used at Logikal
+extras:
+- docker
+jupyter: false
+keywords:
+- python
+- utilities
+license: mit
+name: logikal-utils
+scripts: []
+title: logikal-utils
+

logikal-utils-1.0.0/LICENSE.txt

@@ -0,0 +1,16 @@
+Copyright 2023 Logikal GmbH
+
+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.

logikal-utils-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+exclude .gitignore
+prune .github
+prune docs
+prune tests

logikal-utils-1.0.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.1
+Name: logikal-utils
+Version: 1.0.0
+Summary: Common Python utilities used at Logikal
+Author-email: Logikal GmbH <contact@logikal.io>
+License: Copyright 2023 Logikal GmbH
+        
+        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.
+        
+Project-URL: Documentation, https://docs.logikal.io/logikal-utils/
+Project-URL: Release notes, https://github.com/logikal-io/logikal-utils/releases
+Project-URL: Issue tracker, https://github.com/logikal-io/logikal-utils/issues
+Project-URL: Source code, https://github.com/logikal-io/logikal-utils
+Keywords: python,utilities
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: ~=3.8
+Description-Content-Type: text/x-rst
+Provides-Extra: docker
+License-File: LICENSE.txt
+
+logikal-utils
+=============
+Common Python utilities used at Logikal.
+
+Getting Started
+---------------
+You can find the project documentation under `docs.logikal.io/logikal-utils/
+<https://docs.logikal.io/logikal-utils/>`_.

logikal-utils-1.0.0/README.rst

@@ -0,0 +1,8 @@
+logikal-utils
+=============
+Common Python utilities used at Logikal.
+
+Getting Started
+---------------
+You can find the project documentation under `docs.logikal.io/logikal-utils/
+<https://docs.logikal.io/logikal-utils/>`_.

logikal-utils-1.0.0/compose.yml

@@ -0,0 +1,6 @@
+name: logikal-utils
+
+services:
+  validator:
+    image: ghcr.io/validator/validator:23.4.11
+    ports: [{target: 8888}]

logikal-utils-1.0.0/logikal_utils/docker.py

@@ -0,0 +1,106 @@
+import os
+import subprocess
+from time import sleep, time
+from typing import Optional
+
+from docker import DockerClient, from_env as client_from_env
+from docker.models.containers import Container
+from termcolor import colored
+
+from logikal_utils.project import PYPROJECT
+
+
+class Service:
+    def __init__(  # pylint: disable=too-many-arguments
+        self,
+        name: str,
+        project: Optional[str] = None,
+        start_timeout_seconds: float = 30,
+        ready_log_text: Optional[str] = None,
+        log_poll_seconds: float = 3,
+    ):
+        """
+        Manage a project's Docker Compose services.
+
+        .. note:: Automatically starts all services during initialization whenever necessary.
+        .. note:: Requires the :ref:`docker extra <index:Docker>`.
+
+        Args:
+            name: The name of the service to manage.
+            project: The name of the project to use.
+            start_timeout_seconds: The time to wait for services to start.
+            ready_log_text: The log text that signals that the service is ready.
+            log_poll_seconds: The time to wait between log text polls while waiting for the service
+                to be ready.
+
+        """
+        self.name = name
+        self.project = project or PYPROJECT['project']['name']
+        self.start_timeout_seconds = start_timeout_seconds
+        self.ready_log_text = ready_log_text
+        self.log_poll_seconds = log_poll_seconds
+        try:
+            client = client_from_env()
+            self.container = self._running_container(client=client, start_services=True)
+        finally:
+            client.close()
+
+    def __str__(self) -> str:
+        return f'Docker Compose project "{self.project}" service "{self.name}"'
+
+    def start_services(self) -> None:
+        """
+        Start all Docker Compose services in the given project.
+        """
+        print(colored('Starting Docker Compose services', 'yellow', attrs=['bold']))
+        command = [
+            'docker', 'compose', 'up', '--detach',
+            *(['--quiet-pull'] if 'GITHUB_ACTIONS' in os.environ else []),
+            '--wait', '--wait-timeout', str(self.start_timeout_seconds),
+        ]
+        subprocess.run(command, text=True, check=True)  # nosec: secure, not using untrusted input
+        print()
+
+    def _running_container(self, client: DockerClient, start_services: bool) -> Container:
+        filters = {
+            'status': 'running',
+            'label': [
+                f'com.docker.compose.project={self.project}',
+                f'com.docker.compose.service={self.name}',
+            ],
+        }
+        if containers := client.containers.list(limit=1, filters=filters):
+            container = containers[0]
+            container.reload()  # refresh container attributes
+
+            health = container.attrs['State'].get('Health', {})
+            health_status = health.get('Status')
+            if health_status and health_status != 'healthy':
+                logs = [log['Output'].strip() for log in health.get('Log', {}) if 'Output' in log]
+                logs_str = ('\n\nLogs:\n' + '\n'.join(logs)) if logs else ''
+                raise RuntimeError(f'{self} is not healthy{logs_str}')
+
+            if self.ready_log_text and not start_services:
+                print(f'Waiting for service "{self.name}" to be ready...')
+                wait_start_time = time()
+                while (  # pylint: disable=while-used
+                    self.ready_log_text not in container.logs().decode()
+                ):
+                    if time() - wait_start_time >= self.start_timeout_seconds:
+                        raise RuntimeError(f'{self} is not ready')
+                    sleep(self.log_poll_seconds)
+                print()
+
+            return container
+
+        if start_services:
+            self.start_services()
+            return self._running_container(client=client, start_services=False)
+
+        raise RuntimeError(f'{self} not found')
+
+    def container_port(self, service_port: str) -> str:
+        """
+        Return the container host port that is linked to the given service port.
+        """
+        return str(self.container.ports[service_port][0]['HostPort'])

logikal-utils-1.0.0/logikal_utils/project.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+from typing import Any
+
+import tomli
+
+PATH = Path('pyproject.toml')
+#: The ``pyproject.toml`` configuration of the current project.
+PYPROJECT: Any = tomli.loads(PATH.read_text(encoding='utf-8')) if PATH.exists() else {}
+
+
+def tool_config(name: str) -> Any:
+    """
+    Return the ``pyproject.toml`` configuration of a given tool.
+    """
+    return PYPROJECT.get('tool', {}).get(name, {})

logikal-utils-1.0.0/logikal_utils.egg-info/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.1
+Name: logikal-utils
+Version: 1.0.0
+Summary: Common Python utilities used at Logikal
+Author-email: Logikal GmbH <contact@logikal.io>
+License: Copyright 2023 Logikal GmbH
+        
+        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.
+        
+Project-URL: Documentation, https://docs.logikal.io/logikal-utils/
+Project-URL: Release notes, https://github.com/logikal-io/logikal-utils/releases
+Project-URL: Issue tracker, https://github.com/logikal-io/logikal-utils/issues
+Project-URL: Source code, https://github.com/logikal-io/logikal-utils
+Keywords: python,utilities
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: ~=3.8
+Description-Content-Type: text/x-rst
+Provides-Extra: docker
+License-File: LICENSE.txt
+
+logikal-utils
+=============
+Common Python utilities used at Logikal.
+
+Getting Started
+---------------
+You can find the project documentation under `docs.logikal.io/logikal-utils/
+<https://docs.logikal.io/logikal-utils/>`_.

logikal-utils-1.0.0/logikal_utils.egg-info/SOURCES.txt

@@ -0,0 +1,23 @@
+.copier-answers.yml
+LICENSE.txt
+MANIFEST.in
+README.rst
+compose.yml
+pyproject.toml
+logikal_utils/__init__.py
+logikal_utils/docker.py
+logikal_utils/project.py
+logikal_utils/py.typed
+logikal_utils.egg-info/PKG-INFO
+logikal_utils.egg-info/SOURCES.txt
+logikal_utils.egg-info/dependency_links.txt
+logikal_utils.egg-info/requires.txt
+logikal_utils.egg-info/top_level.txt
+requirements/build.txt
+requirements/build.txt.lock
+requirements/core.txt
+requirements/dev.txt
+requirements/dev.txt.lock
+requirements/docs.txt
+requirements/docs.txt.lock
+requirements/extras/docker.txt

logikal-utils-1.0.0/logikal_utils.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

logikal-utils-1.0.0/logikal_utils.egg-info/requires.txt

@@ -0,0 +1,5 @@
+termcolor~=2.3
+tomli~=2.0
+
+[docker]
+docker~=6.1

logikal-utils-1.0.0/logikal_utils.egg-info/top_level.txt

@@ -0,0 +1 @@
+logikal_utils

logikal-utils-1.0.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ['setuptools>=45', 'setuptools-scm[toml]>=6.2']
+build-backend = 'setuptools.build_meta'
+
+[project]
+name = 'logikal-utils'
+description = 'Common Python utilities used at Logikal'
+readme = 'README.rst'
+requires-python = '~= 3.8'
+license = {file = 'LICENSE.txt'}
+authors = [{name = 'Logikal GmbH', email = 'contact@logikal.io'}]
+keywords = ['python', 'utilities']
+classifiers = [
+  'Development Status :: 5 - Production/Stable',
+  'Intended Audience :: Developers',
+  'License :: OSI Approved :: MIT License',
+  'Operating System :: POSIX :: Linux',
+  'Programming Language :: Python :: 3',
+  'Programming Language :: Python :: 3.8',
+  'Topic :: Software Development',
+  'Typing :: Typed',
+]
+dynamic = ['version', 'dependencies', 'optional-dependencies']
+
+[project.urls]
+'Documentation' = 'https://docs.logikal.io/logikal-utils/'
+'Release notes' = 'https://github.com/logikal-io/logikal-utils/releases'
+'Issue tracker' = 'https://github.com/logikal-io/logikal-utils/issues'
+'Source code' = 'https://github.com/logikal-io/logikal-utils'
+
+[tool.setuptools.dynamic]
+dependencies = {file = 'requirements/core.txt'}
+
+[tool.setuptools.dynamic.optional-dependencies]
+docker = {file = 'requirements/extras/docker.txt'}
+
+[tool.setuptools]
+packages = ['logikal_utils']
+
+[tool.setuptools_scm]
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = [
+  'docker.*',
+]

logikal-utils-1.0.0/requirements/build.txt

@@ -0,0 +1,2 @@
+build==0.10.0
+twine==4.0.2

logikal-utils-1.0.0/requirements/build.txt.lock

@@ -0,0 +1,45 @@
+###################################################################################################
+##
+##  DO NOT EDIT THIS FILE.
+##  This is a locked requirements file generated by pyorbs.
+##
+##  Requirements hash: 1d6dda865959484538d6a587e0ca2c0953051494ea1d4a1dbb5a1d3a6044352d
+##
+###################################################################################################
+bleach==6.0.0
+build==0.10.0
+certifi==2023.5.7
+cffi==1.15.1
+charset-normalizer==3.1.0
+cryptography==41.0.1
+docutils==0.20.1
+idna==3.4
+importlib-metadata==6.7.0
+importlib-resources==5.12.0
+jaraco.classes==3.2.3
+jeepney==0.8.0
+keyring==24.0.0
+markdown-it-py==3.0.0
+mdurl==0.1.2
+more-itertools==9.1.0
+packaging==23.1
+pip==23.1.2
+pkginfo==1.9.6
+pycparser==2.21
+Pygments==2.15.1
+pyproject_hooks==1.0.0
+readme-renderer==40.0
+requests==2.31.0
+requests-toolbelt==1.0.0
+rfc3986==2.0.0
+rich==13.4.2
+SecretStorage==3.3.3
+setuptools==68.0.0
+six==1.16.0
+tomli==2.0.1
+twine==4.0.2
+typing_extensions==4.6.3
+urllib3==2.0.3
+webencodings==0.5.1
+wheel==0.40.0
+zipp==3.15.0

logikal-utils-1.0.0/requirements/core.txt

@@ -0,0 +1,2 @@
+termcolor~=2.3
+tomli~=2.0

logikal-utils-1.0.0/requirements/dev.txt

@@ -0,0 +1,5 @@
+-r core.txt
+-r build.txt
+-r docs.txt
+
+pytest-logikal==1.10.3

logikal-utils-1.0.0/requirements/dev.txt.lock

@@ -0,0 +1,105 @@
+###################################################################################################
+##
+##  DO NOT EDIT THIS FILE.
+##  This is a locked requirements file generated by pyorbs.
+##
+##  Requirements hash: 61dd452dd340aef4cc158330e72e7b6441e309322e0cbe26ce8894e95a406705
+##
+###################################################################################################
+-e .
+alabaster==0.7.13
+astroid==2.15.5
+attrs==23.1.0
+Babel==2.12.1
+bandit==1.7.5
+bleach==6.0.0
+build==0.10.0
+certifi==2023.5.7
+cffi==1.15.1
+charset-normalizer==3.1.0
+colorama==0.4.6
+coverage==7.2.7
+cryptography==41.0.1
+dill==0.3.6
+docker==6.1.3
+docutils==0.17.1
+exceptiongroup==1.1.1
+execnet==1.9.0
+filelock==3.12.2
+gitdb==4.0.10
+GitPython==3.1.31
+idna==3.4
+imagesize==1.4.1
+importlib-metadata==6.7.0
+importlib-resources==5.12.0
+iniconfig==2.0.0
+isort==5.12.0
+jaraco.classes==3.2.3
+jeepney==0.8.0
+Jinja2==3.1.2
+keyring==24.0.0
+lazy-object-proxy==1.9.0
+logikal-docs==1.1.3
+markdown-it-py==3.0.0
+MarkupSafe==2.1.3
+mccabe==0.7.0
+mdurl==0.1.2
+more-itertools==9.1.0
+mypy==1.3.0
+mypy-extensions==1.0.0
+packaging==23.1
+pbr==5.11.1
+Pillow==9.5.0
+pip==23.1.2
+pip-licenses==4.3.2
+pkginfo==1.9.6
+platformdirs==3.7.0
+pluggy==1.2.0
+prettytable==3.8.0
+psutil==5.9.5
+pycodestyle==2.10.0
+pycparser==2.21
+pydocstyle==6.3.0
+Pygments==2.15.1
+pylint==2.17.4
+pyorbs==2.0.0
+pyproject_hooks==1.0.0
+pytest==7.3.1
+pytest-cov==4.1.0
+pytest-logikal==1.10.3
+pytest-mock==3.10.0
+pytest-mypy==0.10.3
+pytest-xdist==3.3.1
+pytz==2023.3
+PyYAML==6.0
+readme-renderer==40.0
+requests==2.31.0
+requests-toolbelt==1.0.0
+rfc3986==2.0.0
+rich==13.4.2
+SecretStorage==3.3.3
+setuptools==68.0.0
+six==1.16.0
+smmap==5.0.0
+snowballstemmer==2.2.0
+Sphinx==5.3.0
+sphinx-rtd-theme==1.1.1
+sphinxcontrib-applehelp==1.0.4
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+stevedore==5.1.0
+termcolor==2.3.0
+tomli==2.0.1
+tomlkit==0.11.8
+twine==4.0.2
+typing_extensions==4.6.3
+urllib3==2.0.3
+wcwidth==0.2.6
+webencodings==0.5.1
+websocket-client==1.6.0
+wheel==0.40.0
+wrapt==1.15.0
+zipp==3.15.0

logikal-utils-1.0.0/requirements/docs.txt

@@ -0,0 +1,5 @@
+-e .
+-r core.txt
+-r extras/docker.txt
+
+logikal-docs==1.1.3

logikal-utils-1.0.0/requirements/docs.txt.lock

@@ -0,0 +1,42 @@
+###################################################################################################
+##
+##  DO NOT EDIT THIS FILE.
+##  This is a locked requirements file generated by pyorbs.
+##
+##  Requirements hash: 77d551a2ebc640afc10cd1e4f41d7c5bc48119e100bfb0bbffc67821d96ad388
+##
+###################################################################################################
+-e .
+alabaster==0.7.13
+Babel==2.12.1
+certifi==2023.5.7
+charset-normalizer==3.1.0
+docker==6.1.3
+docutils==0.17.1
+idna==3.4
+imagesize==1.4.1
+importlib-metadata==6.7.0
+Jinja2==3.1.2
+logikal-docs==1.1.3
+MarkupSafe==2.1.3
+packaging==23.1
+pip==23.1.2
+Pygments==2.15.1
+pytz==2023.3
+requests==2.31.0
+setuptools==68.0.0
+snowballstemmer==2.2.0
+Sphinx==5.3.0
+sphinx-rtd-theme==1.1.1
+sphinxcontrib-applehelp==1.0.4
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+termcolor==2.3.0
+tomli==2.0.1
+urllib3==2.0.3
+websocket-client==1.6.0
+wheel==0.40.0
+zipp==3.15.0

logikal-utils-1.0.0/requirements/extras/docker.txt

@@ -0,0 +1 @@
+docker~=6.1

logikal-utils-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+