duppla-slack 2024.12__tar.gz

duppla_slack-2024.12/LICENSE

@@ -0,0 +1,16 @@
+Copyright [2024] duppla
+
+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 only within duppla, 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.

duppla_slack-2024.12/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.1
+Name: duppla_slack
+Version: 2024.12
+Summary: Custom implementation for Slack API
+Author: duppla
+Author-email: <>
+Keywords: python,slack,duppla
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3.0.0,>=2.10.0
+Requires-Dist: requests
+Requires-Dist: shortuuid
+Requires-Dist: slack_sdk<4.0.0,>3.30.0
+Requires-Dist: Unidecode
+
+A custom implementation for Slack API using Python, based on the official API + SDK.

duppla_slack-2024.12/README.md

@@ -0,0 +1,17 @@
+# Slack [Aplicacion interna de duppla]
+
+La plataforma de Slack ofrece un SDK para poder interactuar con la API de Slack. Este paquete de Python está diseñado exclusivamente para el uso interno de duppla a través de los diversos repositorios de la organización.
+
+> [!IMPORTANT]
+> Este paquete no está disponible para su uso externo.
+
+## Instalación[^1]
+
+```bash
+pip install git+https://<BOT TOKEN>@github.com/duppla/duppla_slack
+```
+
+[^1]: Reemplace <BOT TOKEN> por el token de acceso del bot de github. (Preguntar a los administradores de la organización)
+
+> [!NOTE]
+> Para mas información sobre la API de Slack, visite [Slack API](https://api.slack.com/) y la librería de Python [Slack API](https://github.com/slackapi/python-slack-sdk)

duppla_slack-2024.12/duppla_slack/__init__.py

@@ -0,0 +1,18 @@
+from duppla_slack.constants.channels import (
+    AIRFLOW_CHANNEL as AIRFLOW_CHANNEL,
+    GENERAL_CHANNEL as GENERAL_CHANNEL,
+    RANDOM_CHANNEL as RANDOM_CHANNEL,
+)
+from duppla_slack.constants.templates import Filetype as Filetype
+from duppla_slack.models import (
+    Attachment as Attachment,
+    AttachmentOld as AttachmentOld,
+    Bookmark as Bookmark,
+    EphemeralMessage as EphemeralMessage,
+    LongMessage as LongMessage,
+    Message as Message,
+    ScheduledMessage as ScheduledMessage,
+    SlackApiError as SlackApiError,
+    SlackProfile as SlackProfile,
+)
+from duppla_slack.service.public import SlackService as SlackService

duppla_slack-2024.12/duppla_slack/models/__init__.py

@@ -0,0 +1,25 @@
+from slack_sdk.errors import SlackApiError as SlackApiError
+
+from .duppla import SlackProfile as SlackProfile
+
+from .message import Message as Message  # isort:skip
+from .message import (
+    Attachment as Attachment,
+    AttachmentOld as AttachmentOld,
+    Bookmark as Bookmark,
+    EphemeralMessage as EphemeralMessage,
+    LongMessage as LongMessage,
+    ScheduledMessage as ScheduledMessage,
+)
+
+__all__ = [
+    "SlackProfile",
+    "Message",
+    "Attachment",
+    "AttachmentOld",
+    "Bookmark",
+    "EphemeralMessage",
+    "LongMessage",
+    "ScheduledMessage",
+    "SlackApiError",
+]

duppla_slack-2024.12/duppla_slack/models/duppla.py

@@ -0,0 +1,18 @@
+from typing import TypedDict
+
+
+class SlackProfile(TypedDict):
+    real_name: str
+    real_name_normalized: str
+    display_name: str
+    display_name_normalized: str
+    status_text: str
+    status_emoji: str
+    email: str
+    image_24: str
+    image_32: str
+    image_48: str
+    image_72: str
+    image_192: str
+    image_512: str
+    is_bot: bool

duppla_slack-2024.12/duppla_slack/models/message.py

@@ -0,0 +1,123 @@
+from typing import Any, Literal, TypedDict
+from pydantic import AliasChoices, BaseModel, Field
+
+from duppla_slack.constants.channels import AIRFLOW_CHANNEL
+from duppla_slack.constants.templates import Filetype
+
+
+class Attachment(TypedDict, total=False):
+    """
+    Represents an attachment for a message to send to a Slack channel.
+    Check the official documentation of the Slack API for more information: https://api.slack.com/reference/messaging/attachments
+    """
+
+    title: str | None
+    value: str | None
+    short: bool
+    blocks: list[dict[str, Any]]
+    color: Literal["good", "warning", "danger"] | str
+
+
+class AttachmentOld(TypedDict, total=False):
+    """
+    Represents an attachment for a message to send to a Slack channel.
+    Check the official documentation of the Slack API for more information: https://api.slack.com/reference/messaging/attachments
+    """
+
+    author_icon: str
+    author_link: str
+    author_name: str
+    fallback: str
+    fields: list[dict[str, Any]]
+    footer: str
+    footer_icon: str
+    image_url: str
+    mrkdwn_in: list[str]
+    pretext: str
+    text: str
+    thumb_url: str
+    title: str
+    title_link: str
+    ts: str | int
+
+
+class Message(BaseModel):
+    """
+    Represents the body of the request to send a message to a Slack channel.
+    The body may contain attachments or blocks for rich content.
+    # NOTE:
+        - If the channel is a user ID, the message will be sent as a direct message to that user.
+        - If the thread_ts is set, the message will be sent as a reply to the specified thread and if the reply_broadcast is set to True, the message will also be sent to the entire channel.
+
+    > Check the official documentation of the Slack API for more information: https://api.slack.com/methods/chat.postMessage
+    """
+
+    text: str = Field(validation_alias=AliasChoices("text", "msg"))
+    channel: str = Field(default=AIRFLOW_CHANNEL, validation_alias=AliasChoices("channel", "channel_id"))  # fmt:skip
+    thread_ts: str | None = None
+    reply_broadcast: bool | None = False
+    attachments: list[Attachment | AttachmentOld] | None = None
+    blocks: list[dict[str, Any]] | None = None
+
+
+class LongMessage(BaseModel):
+    """
+    Represents the body of the request to send a long message to a Slack channel.
+    The message is sent as a file, to avoid the truncate originated from the 4000 characters limit of the text field.
+
+    # NOTE:
+        - If the channel is a user ID, it will thrown an error, pass instead a Direct Channel ID.
+        - The original method will be deprecated soon, so it is recommended to use the wrapper `files.uploadv2` of the actual two methods: `files.getUploadURLExternal` and `files.completeUploadExternal`
+
+    > Check the official documentation of the Slack API for more information:
+        > https://api.slack.com/methods/files.upload  [Deprecated but shows the use of files.uploadv2]
+        > https://api.slack.com/methods/files.getUploadURLExternal
+        > https://api.slack.com/methods/files.completeUploadExternal
+    """
+
+    initial_comment: str | None = Field(default=None, validation_alias=AliasChoices("initial_comment", "msg", "text"))  # fmt:skip
+    """The message to be sent as a header before the file."""
+    content: str
+    """A string representing the file content."""
+    channel: str = Field(default=AIRFLOW_CHANNEL, validation_alias=AliasChoices("channel", "channel_id"))  # fmt:skip
+    """The channel ID or name where the message will be sent. (It must start with 'C', 'G', 'D' or 'Z', meaning channel, group, direct message or user respectively.)"""
+    thread_ts: str | int | None = None
+    reply_broadcast: bool = False
+    snippet_type: Filetype = Field(default="auto", validation_alias=AliasChoices("snippet_type", "type", "filetype"))  # fmt:skip
+    """The type of the file content to display following the snippet format, see https://api.slack.com/types/file#types"""
+
+
+class EphemeralMessage(Message):
+    """
+    Represents the body of the request to send an ephemeral message to a Slack user.
+    The body (like the parent class Message) may contain attachments or blocks for rich content.
+    # NOTE: If the channel is a user ID, the message will be sent as a direct message to that user.
+    > Check the official documentation of the Slack API for more information: https://api.slack.com/methods/chat.postEphemeral
+    """
+
+    user: str
+
+
+class ScheduledMessage(Message):
+    """
+    Represents the body of the request to schedule a message to a Slack channel.
+    The body (like the parent class Message) may contain attachments or blocks for rich content.
+    # NOTE: If the channel is a user ID, the message will be sent as a direct message to that user.
+    > Check the official documentation of the Slack API for more information: https://api.slack.com/methods/chat.scheduleMessage
+    """
+
+    post_at: int  # Unix time
+    reply_broadcast: bool | None = False
+
+
+class Bookmark(BaseModel):
+    """
+    Represents a bookmark for a message to send to a Slack channel.
+    Check the official documentation of the Slack API for more information: https://api.slack.com/reference/messaging/blocks
+    """
+
+    channel_id: str
+    title: str
+    type: str
+    emoji: str | None = None
+    link: str | None = None

duppla_slack-2024.12/duppla_slack.egg-info/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.1
+Name: duppla_slack
+Version: 2024.12
+Summary: Custom implementation for Slack API
+Author: duppla
+Author-email: <>
+Keywords: python,slack,duppla
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3.0.0,>=2.10.0
+Requires-Dist: requests
+Requires-Dist: shortuuid
+Requires-Dist: slack_sdk<4.0.0,>3.30.0
+Requires-Dist: Unidecode
+
+A custom implementation for Slack API using Python, based on the official API + SDK.

duppla_slack-2024.12/duppla_slack.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.py
+duppla_slack/__init__.py
+duppla_slack.egg-info/PKG-INFO
+duppla_slack.egg-info/SOURCES.txt
+duppla_slack.egg-info/dependency_links.txt
+duppla_slack.egg-info/requires.txt
+duppla_slack.egg-info/top_level.txt
+duppla_slack/models/__init__.py
+duppla_slack/models/duppla.py
+duppla_slack/models/message.py
+duppla_slack/utils/__init__.py

duppla_slack-2024.12/duppla_slack.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

duppla_slack-2024.12/duppla_slack.egg-info/requires.txt

@@ -0,0 +1,5 @@
+pydantic<3.0.0,>=2.10.0
+requests
+shortuuid
+slack_sdk<4.0.0,>3.30.0
+Unidecode

duppla_slack-2024.12/duppla_slack.egg-info/top_level.txt

@@ -0,0 +1 @@
+duppla_slack

duppla_slack-2024.12/setup.cfg

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

duppla_slack-2024.12/setup.py

@@ -0,0 +1,29 @@
+import setuptools as st
+
+# Setting up
+st.setup(
+    name="duppla_slack",
+    version="2024.12",
+    author="duppla",
+    author_email="<>",
+    description="Custom implementation for Slack API",
+    long_description_content_type="text/markdown",
+    long_description="A custom implementation for Slack API using Python, based on the official API + SDK.",
+    packages=st.find_packages(),
+    install_requires=[
+        "pydantic>=2.10.0,<3.0.0",
+        "requests",
+        "shortuuid",
+        "slack_sdk>3.30.0,<4.0.0",
+        "Unidecode",
+    ],
+    keywords=["python", "slack", "duppla"],
+    classifiers=[
+        "Development Status :: 1 - Planning",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python :: 3",
+        "Operating System :: Unix",
+        "Operating System :: MacOS :: MacOS X",
+        "Operating System :: Microsoft :: Windows",
+    ],
+)