atk-common 0.2.0__tar.gz

atk_common-0.2.0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: atk_common
+Version: 0.2.0
+Summary: ATK common methods
+Home-page: https://github.com/pypa/atk_common
+Author: Roger
+Author-email: roger@perspic.tech
+Project-URL: Bug Reports, https://github.com/pypa/atk_common/issues
+Project-URL: Funding, https://donate.pypi.org
+Project-URL: Say Thanks!, http://saythanks.io/to/example
+Project-URL: Source, https://github.com/pypa/atk_common/
+Keywords: sample,setuptools,development
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: license.txt
+Requires-Dist: kombu>=5.4.2
+Requires-Dist: requests>=2.32.3
+
+This package contains atk enforcement common entities and components

atk_common-0.2.0/README.md

@@ -0,0 +1 @@
+This package contains atk enforcement common entities and components

atk_common-0.2.0/license.txt

@@ -0,0 +1,7 @@
+Copyright 2023 Perspic AS
+
+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.

atk_common-0.2.0/pyproject.toml

@@ -0,0 +1,4 @@
+# pyproject.toml file specified at the root of the directory
+[build-system]
+requires = ["setuptools>=42", "wheel"]   # PEP 508 specifications.
+build-backend = "setuptools.build_meta"

atk_common-0.2.0/setup.cfg

@@ -0,0 +1,30 @@
+[metadata]
+name = atk_common
+version = 1.0.0
+author = Roger Jakobsen
+author_email = roger@rogerjakobsen.no
+description = Atk enforcement common entities and components
+long_description = file: README.md, LICENSE.txt
+long_description_content_type = text/markdown
+url = https://github.com/perspictech/bo-atk-common
+project_urls = 
+	Bug Tracker = https://github.com/perspictech/bo-atk-common/-/issues
+	repository = https://github.com/perspictech/bo-atk-common
+classifiers = 
+	Programming Language :: Python :: 3
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.6
+
+[options.packages.find]
+where = src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

atk_common-0.2.0/setup.py

@@ -0,0 +1,173 @@
+"""A setuptools based setup module.
+
+See:
+https://packaging.python.org/guides/distributing-packages-using-setuptools/
+https://github.com/pypa/atk_common
+"""
+
+# Always prefer setuptools over distutils
+from setuptools import setup, find_packages
+import pathlib
+
+here = pathlib.Path(__file__).parent.resolve()
+
+# Get the long description from the README file
+long_description = (here / "README.md").read_text(encoding="utf-8")
+
+# Arguments marked as "Required" below must be included for upload to PyPI.
+# Fields marked as "Optional" may be commented out.
+
+setup(
+    # This is the name of your project. The first time you publish this
+    # package, this name will be registered for you. It will determine how
+    # users can install this project, e.g.:
+    #
+    # $ pip install atk_common
+    #
+    # And where it will live on PyPI: https://pypi.org/project/atk_common/
+    #
+    # There are some restrictions on what makes a valid project name
+    # specification here:
+    # https://packaging.python.org/specifications/core-metadata/#name
+    name="atk_common",  # Required
+    # Versions should comply with PEP 440:
+    # https://www.python.org/dev/peps/pep-0440/
+    #
+    # For a discussion on single-sourcing the version across setup.py and the
+    # project code, see
+    # https://packaging.python.org/guides/single-sourcing-package-version/
+    version="0.2.0",  # Required
+    # This is a one-line description or tagline of what your project does. This
+    # corresponds to the "Summary" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#summary
+    description="ATK common methods",  # Optional
+    # This is an optional longer description of your project that represents
+    # the body of text which users will see when they visit PyPI.
+    #
+    # Often, this is the same as your README, so you can just read it in from
+    # that file directly (as we have already done above)
+    #
+    # This field corresponds to the "Description" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#description-optional
+    long_description=long_description,  # Optional
+    # Denotes that our long_description is in Markdown; valid values are
+    # text/plain, text/x-rst, and text/markdown
+    #
+    # Optional if long_description is written in reStructuredText (rst) but
+    # required for plain-text or Markdown; if unspecified, "applications should
+    # attempt to render [the long_description] as text/x-rst; charset=UTF-8 and
+    # fall back to text/plain if it is not valid rst" (see link below)
+    #
+    # This field corresponds to the "Description-Content-Type" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
+    long_description_content_type="text/markdown",  # Optional (see note above)
+    # This should be a valid link to your project's main homepage.
+    #
+    # This field corresponds to the "Home-Page" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#home-page-optional
+    url="https://github.com/pypa/atk_common",  # Optional
+    # This should be your name or the name of the organization which owns the
+    # project.
+    author="Roger",  # Optional
+    # This should be a valid email address corresponding to the author listed
+    # above.
+    author_email="roger@perspic.tech",  # Optional
+    # Classifiers help users find your project by categorizing it.
+    #
+    # For a list of valid classifiers, see https://pypi.org/classifiers/
+    classifiers=[  # Optional
+        # How mature is this project? Common values are
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        "Development Status :: 3 - Alpha",
+        # Indicate who your project is intended for
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Build Tools",
+        # Pick your license as you wish
+        "License :: OSI Approved :: MIT License",
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate you support Python 3. These classifiers are *not*
+        # checked by 'pip install'. See instead 'python_requires' below.
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3 :: Only",
+    ],
+    # This field adds keywords for your project which will appear on the
+    # project page. What does your project relate to?
+    #
+    # Note that this is a list of additional keywords, separated
+    # by commas, to be used to assist searching for the distribution in a
+    # larger catalog.
+    keywords="sample, setuptools, development",  # Optional
+    # When your source code is in a subdirectory under the project root, e.g.
+    # `src/`, it is necessary to specify the `package_dir` argument.
+    package_dir={"": "src"},  # Optional
+    # You can just specify package directories manually here if your project is
+    # simple. Or you can use find_packages().
+    #
+    # Alternatively, if you just want to distribute a single Python file, use
+    # the `py_modules` argument instead as follows, which will expect a file
+    # called `my_module.py` to exist:
+    #
+    #   py_modules=["my_module"],
+    #
+    packages=find_packages(where="src"),  # Required
+    # Specify which Python versions you support. In contrast to the
+    # 'Programming Language' classifiers above, 'pip install' will check this
+    # and refuse to install the project if the version does not match. See
+    # https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
+    python_requires='>=3.11',
+    # This field lists other packages that your project depends on to run.
+    # Any package you put here will be installed by pip when your project is
+    # installed, so they must be valid existing projects.
+    #
+    # For an analysis of "install_requires" vs pip's requirements files see:
+    # https://packaging.python.org/discussions/install-requires-vs-requirements/
+    install_requires=[  # List external dependencies here
+        'kombu>=5.4.2',
+        'requests>=2.32.3'
+    ],
+    # List additional groups of dependencies here (e.g. development
+    # dependencies). Users will be able to install these using the "extras"
+    # syntax, for example:
+    #
+    #   $ pip install atk_common[dev]
+    #
+    # Similar to `install_requires` above, these must be valid existing
+    # projects.
+    # extras_require={  # Optional
+    #     "dev": ["check-manifest"],
+    #     "test": ["coverage"],
+    # },
+    # If there are data files included in your packages that need to be
+    # installed, specify them here.
+    # package_data={  # Optional
+    #     "sample": ["package_data.dat"],
+    # },
+    # Entry points. The following would provide a command called `sample` which
+    # executes the function `main` from this package when invoked:
+    # entry_points={  # Optional
+    #     "console_scripts": [
+    #         "sample=sample:main",
+    #     ],
+    # },
+    # List additional URLs that are relevant to your project as a dict.
+    #
+    # This field corresponds to the "Project-URL" metadata fields:
+    # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
+    #
+    # Examples listed include a pattern for specifying where the package tracks
+    # issues, where the source is hosted, where to say thanks to the package
+    # maintainers, and where to support the project financially. The key is
+    # what's used to render the link text on PyPI.
+    project_urls={  # Optional
+        "Bug Reports": "https://github.com/pypa/atk_common/issues",
+        "Funding": "https://donate.pypi.org",
+        "Say Thanks!": "http://saythanks.io/to/example",
+        "Source": "https://github.com/pypa/atk_common/",
+    },
+)

atk_common-0.2.0/src/atk_common.egg-info/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: atk_common
+Version: 0.2.0
+Summary: ATK common methods
+Home-page: https://github.com/pypa/atk_common
+Author: Roger
+Author-email: roger@perspic.tech
+Project-URL: Bug Reports, https://github.com/pypa/atk_common/issues
+Project-URL: Funding, https://donate.pypi.org
+Project-URL: Say Thanks!, http://saythanks.io/to/example
+Project-URL: Source, https://github.com/pypa/atk_common/
+Keywords: sample,setuptools,development
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: license.txt
+Requires-Dist: kombu>=5.4.2
+Requires-Dist: requests>=2.32.3
+
+This package contains atk enforcement common entities and components

atk_common-0.2.0/src/atk_common.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+license.txt
+pyproject.toml
+setup.cfg
+setup.py
+src/atk_common.egg-info/PKG-INFO
+src/atk_common.egg-info/SOURCES.txt
+src/atk_common.egg-info/dependency_links.txt
+src/atk_common.egg-info/requires.txt
+src/atk_common.egg-info/top_level.txt
+src/atk_package/__init__.py
+src/atk_package/datetime_utils.py
+src/atk_package/log_utils.py
+src/atk_package/rabbitmq_consumer.py
+src/shared_python_atk_enforcement/__init__.py

atk_common-0.2.0/src/atk_common.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

atk_common-0.2.0/src/atk_common.egg-info/requires.txt

@@ -0,0 +1,2 @@
+kombu>=5.4.2
+requests>=2.32.3

atk_common-0.2.0/src/atk_common.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+atk_package
+shared_python_atk_enforcement

atk_common-0.2.0/src/atk_package/__init__.py

@@ -0,0 +1,4 @@
+# __init__.py
+from .rabbitmq_consumer import RabbitMQConsumer
+from .datetime_utils import date_time_utc, get_utc_date_time
+from .log_utils import add_log_item, add_log_item_http

atk_common-0.2.0/src/atk_package/datetime_utils.py

@@ -0,0 +1,7 @@
+from datetime import datetime, timezone
+
+def date_time_utc(column):
+    return 'TO_CHAR({0} at time zone \'UTC\', \'yyyy-mm-dd hh24:mi:ss.ms"Z"\')'.format(column)
+
+def get_utc_date_time():
+    return str(datetime.now(timezone.utc))

atk_common-0.2.0/src/atk_package/log_utils.py

@@ -0,0 +1,16 @@
+from datetime import datetime
+from datetime_utils import get_utc_date_time
+
+def create_date_time():
+    date_time = get_utc_date_time()
+    return '[' + date_time + '] '
+
+def add_log_item(text):
+    print(create_date_time() + text)
+
+def add_log_item_http(resp):
+    if resp.status_code == 500:
+        err_resp_json = resp.json().get('message')
+        add_log_item(err_resp_json)
+    else:
+        add_log_item(resp.text)

atk_common-0.2.0/src/atk_package/rabbitmq_consumer.py

@@ -0,0 +1,49 @@
+from kombu import Connection, Exchange, Queue, Consumer
+import socket
+import time
+
+class RabbitMQConsumer:
+    def __init__(self, queue_name, user, pwd, host, vhost, dlx, dlq, encoding, message_handler, log):
+
+        rabbit_url = 'amqp://' + user + ':' + pwd + '@' + host + '/' + vhost
+
+        self.connection = Connection(rabbit_url, heartbeat=10)
+        queue = None
+        if dlx is not None and dlq is not None:
+            queue = Queue(name=queue_name,
+                        queue_arguments={
+                            'x-dead-letter-exchange': dlx, 
+                            'x-dead-letter-routing-key': dlq},
+                        )
+        else:
+            queue = Queue(name=queue_name)
+        self.consumer = Consumer(self.connection, queues=queue, callbacks=[message_handler], accept=[encoding])
+        self.consumer.consume()
+
+        self.message_handler = message_handler  # Custom message handler
+        self.log = log
+    
+    def consume(self):
+        new_conn = self.establish_connection()
+        while True:
+            try:
+                new_conn.drain_events(timeout=2)
+            except socket.timeout:
+                new_conn.heartbeat_check()
+
+    def establish_connection(self):
+        revived_connection = self.connection.clone()
+        revived_connection.ensure_connection(max_retries=3)
+        channel = revived_connection.channel()
+        self.consumer.revive(channel)
+        self.consumer.consume()
+        self.log("Connection revived!")
+        return revived_connection
+        
+    def run(self):
+        while True:
+            try:
+                self.consume()
+            except self.connection.connection_errors:
+                pass
+