init

Author: haru-mamburu

.gitignore

@@ -0,0 +1,148 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# VS code workspaces
+*.code-workspace

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+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.

README.md

@@ -0,0 +1 @@
+Post process information to the slack without clogging up the channel with a bunch of messages. Easyly update status, see when oreration started / finished and how much time it took.

setup.py

@@ -0,0 +1,16 @@
+from setuptools import setup, find_packages
+
+VERSION = "0.0.4"
+DESCRIPTION = "Easyly post good looking slack messages about your operations"
+LONG_DESCRIPTION = "Post process information to the slack without clogging up the channel with a bunch of messages. Easyly update status, see when oreration started / finished and how much time it took."
+
+setup(
+    name="slackops",
+    version=VERSION,
+    author="Alexey Eremin",
+    author_email="haru.eaa@gmail.com",
+    description=DESCRIPTION,
+    long_description=LONG_DESCRIPTION,
+    packages=find_packages(),
+    install_requires=["pytz", "slack_sdk"],
+)

slackops/__init__.py

@@ -0,0 +1 @@
+from .interfaces import Operation, Message

slackops/blocks.py

@@ -0,0 +1,141 @@
+from __future__ import annotations
+from slack_sdk.models.attachments import BlockAttachment
+from slack_sdk.models.blocks.blocks import (
+    SectionBlock,
+    ContextBlock,
+    HeaderBlock,
+    Block,
+    DividerBlock,
+)
+from slack_sdk.models.blocks.basic_components import MarkdownTextObject
+
+
+class Message:
+    def __init__(self, text, header="", context: list = None):
+        self.text = text
+        self.header = header
+        self.context = context
+
+
+class Operation:
+    def __init__(self, name: str, status: str, started: str, finished: str | None = ""):
+        self.name = name
+        self.status = status
+        self.started = started
+        self.finished = finished
+
+    def __bool__(self):
+        return all([self.name, self.status, self.started])
+
+
+class BlockTemplate:
+    @staticmethod
+    def header(
+        text: str | None = "", block_id: str | None = "header"
+    ) -> HeaderBlock | None:
+        if text:
+            return HeaderBlock(text=text, block_id=block_id)
+
+    @staticmethod
+    def text(text: str = None, block_id: str | None = "text") -> SectionBlock | None:
+        if text:
+            return SectionBlock(block_id=block_id, text=MarkdownTextObject(text=text))
+
+    @staticmethod
+    def operation(
+        operation: Operation, block_id: str | None = "operation"
+    ) -> SectionBlock | None:
+        if operation:
+            fields = [
+                MarkdownTextObject(text=operation.name),
+                MarkdownTextObject(text=operation.started),
+                MarkdownTextObject(text=operation.status),
+            ]
+            if operation.finished:
+                fields.append(MarkdownTextObject(text=operation.finished))
+
+            return SectionBlock(
+                block_id=block_id,
+                fields=fields,
+            )
+
+    @staticmethod
+    def context(
+        context: list = None, block_id: str | None = "context"
+    ) -> ContextBlock | None:
+        if context:
+            return ContextBlock(
+                block_id=block_id,
+                elements=[MarkdownTextObject(text=element) for element in context],
+            )
+
+
+class BlockComposition:
+    @staticmethod
+    def context(context: list = None) -> list[DividerBlock | ContextBlock | None]:
+        if context:
+            context = [
+                DividerBlock(),
+                BlockTemplate.context(context),
+            ]
+        return context or []
+
+    @staticmethod
+    def message(message: Message) -> list[Block | None]:
+        blocks = [
+            BlockTemplate.header(message.header),
+            BlockTemplate.text(message.text),
+            *BlockComposition.context(message.context),
+        ]
+        return blocks
+
+    @staticmethod
+    def operation(operation: Operation, message: Message) -> list[Block | None]:
+        blocks = [
+            BlockTemplate.header(message.header),
+            BlockTemplate.text(message.text),
+            BlockTemplate.operation(operation),
+            *BlockComposition.context(message.context),
+        ]
+        return blocks
+
+
+class AttachmentTemplate:
+    @staticmethod
+    def attachment(
+        blocks: list, color: str = None, fallback: str = None
+    ) -> BlockAttachment:
+        return BlockAttachment(blocks=filter(None, blocks), color=color, fallback=fallback)  # type: ignore
+
+    @staticmethod
+    def message(
+        text: str = None,
+        color: str = None,
+        header: str = None,
+        context: list = None,
+    ) -> BlockAttachment:
+        blocks = BlockComposition.message(Message(text, header, context))
+        fallback = text or header
+        return AttachmentTemplate.attachment(
+            blocks=blocks, color=color, fallback=fallback
+        )
+
+    @staticmethod
+    def operation(
+        name: str = "",
+        status: str = "",
+        started: str = "",
+        header: str = None,
+        text: str = None,
+        context: list = None,
+        color: str = None,
+        finished: str = None,
+    ) -> BlockAttachment:
+        blocks = BlockComposition.operation(
+            Operation(name, status, started, finished), Message(text, header, context)
+        )
+        fallback = status or text or header
+
+        return AttachmentTemplate.attachment(
+            blocks=blocks, color=color, fallback=fallback
+        )