django-slack-tools 0.1.0__tar.gz

django_slack_tools-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Yuchan Lee
+
+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.

django_slack_tools-0.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: django-slack-tools
+Version: 0.1.0
+Summary: Little helpers working with Slack bot 🤖 in Django.
+License: MIT
+Author: Yuchan Lee
+Author-email: lasuillard@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: django (>=3.2,<5)
+Requires-Dist: pydantic (>=2,<3)
+Requires-Dist: slack-bolt (>=1,<2)
+Description-Content-Type: text/markdown
+
+# django-slack-tools
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/lasuillard/django-slack-tools/actions/workflows/ci.yaml/badge.svg)](https://github.com/lasuillard/django-slack-tools/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/lasuillard/django-slack-tools/graph/badge.svg?token=c8kzjqjplF)](https://codecov.io/gh/lasuillard/django-slack-tools)
+
+Little helpers working with Slack bot 🤖 in Django.
+
+This project aims to implementing helpful features making Slack bot and providing reusable Django apps integrated with database.
+
+## ✨ Features
+
+Key features are:
+
+- [x] Reusable Django app for Slack messaging with various messaging backends for different environments
+
+- [x] Database-backed Slack messaging policies with simple dictionary-based template
+
+- [x] Message histories
+
+- [x] Built-in admin for management working with Slack workspace
+
+And more in future roadmap...
+
+- [ ] Celery support for messaging backends, management and shortcut tasks, etc.
+
+- [ ] Django template support
+
+- [ ] New Django apps and helpers for Slack features such as modals, event subscription, etc.
+
+Currently it is focused on messaging features. In future, hoping to bring more helpful features across Slack Bot ecosystem, such as event subscriptions, modals, bot interactions, etc.
+
+## 🚀 Installation
+
+**django-slack-tools** supports Python 3.8+ and Django 3.2+. Supports for each deps will be dropped as soon as the ends of security updates.
+
+Install the package:
+
+```bash
+$ pip install django-slack-tools
+```
+
+Add the app to the your Django settings:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "django.contrib.messages", # Used in admin
+    "django_slack_tools.slack_messages",
+    ...
+]
+```
+
+Add configuration for application:
+
+```python
+DJANGO_SLACK_TOOLS = {
+    # Module path to Slack Bolt application or callable returns the app
+    "SLACK_APP": "path.to.your.slack.app",
+
+    # Messaging backend configuration
+    "BACKEND": {
+        "NAME": "django_slack_tools.slack_messages.backends.SlackBackend",
+        "OPTIONS": {
+            # TODO(#44): Reasonable defaults to reduce some duplicates
+            "slack_app": "path.to.your.slack.app",
+        }
+    }
+}
+```
+
+Then, run the database migration and send messages:
+
+```python
+from django_slack_tools.slack_messages.message import slack_message
+
+message = slack_message(
+    "I like threading",
+    channel="id-of-channel",
+    header={"reply_broadcast": True},
+)
+```
+
+Please check the [documentation](https://lasuillard.github.io/django-slack-tools/) for more about details.
+
+## 💖 Contributing
+
+All contributions and helps are welcome. Please check the [CONTRIBUTING.md](./CONTRIBUTING.md) file for about details.
+
+## 📜 License
+
+This project is licensed under the terms of the MIT license.
+

django_slack_tools-0.1.0/README.md

@@ -0,0 +1,92 @@
+# django-slack-tools
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/lasuillard/django-slack-tools/actions/workflows/ci.yaml/badge.svg)](https://github.com/lasuillard/django-slack-tools/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/lasuillard/django-slack-tools/graph/badge.svg?token=c8kzjqjplF)](https://codecov.io/gh/lasuillard/django-slack-tools)
+
+Little helpers working with Slack bot 🤖 in Django.
+
+This project aims to implementing helpful features making Slack bot and providing reusable Django apps integrated with database.
+
+## ✨ Features
+
+Key features are:
+
+- [x] Reusable Django app for Slack messaging with various messaging backends for different environments
+
+- [x] Database-backed Slack messaging policies with simple dictionary-based template
+
+- [x] Message histories
+
+- [x] Built-in admin for management working with Slack workspace
+
+And more in future roadmap...
+
+- [ ] Celery support for messaging backends, management and shortcut tasks, etc.
+
+- [ ] Django template support
+
+- [ ] New Django apps and helpers for Slack features such as modals, event subscription, etc.
+
+Currently it is focused on messaging features. In future, hoping to bring more helpful features across Slack Bot ecosystem, such as event subscriptions, modals, bot interactions, etc.
+
+## 🚀 Installation
+
+**django-slack-tools** supports Python 3.8+ and Django 3.2+. Supports for each deps will be dropped as soon as the ends of security updates.
+
+Install the package:
+
+```bash
+$ pip install django-slack-tools
+```
+
+Add the app to the your Django settings:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "django.contrib.messages", # Used in admin
+    "django_slack_tools.slack_messages",
+    ...
+]
+```
+
+Add configuration for application:
+
+```python
+DJANGO_SLACK_TOOLS = {
+    # Module path to Slack Bolt application or callable returns the app
+    "SLACK_APP": "path.to.your.slack.app",
+
+    # Messaging backend configuration
+    "BACKEND": {
+        "NAME": "django_slack_tools.slack_messages.backends.SlackBackend",
+        "OPTIONS": {
+            # TODO(#44): Reasonable defaults to reduce some duplicates
+            "slack_app": "path.to.your.slack.app",
+        }
+    }
+}
+```
+
+Then, run the database migration and send messages:
+
+```python
+from django_slack_tools.slack_messages.message import slack_message
+
+message = slack_message(
+    "I like threading",
+    channel="id-of-channel",
+    header={"reply_broadcast": True},
+)
+```
+
+Please check the [documentation](https://lasuillard.github.io/django-slack-tools/) for more about details.
+
+## 💖 Contributing
+
+All contributions and helps are welcome. Please check the [CONTRIBUTING.md](./CONTRIBUTING.md) file for about details.
+
+## 📜 License
+
+This project is licensed under the terms of the MIT license.

django_slack_tools-0.1.0/django_slack_tools/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

django_slack_tools-0.1.0/django_slack_tools/app_settings.py

@@ -0,0 +1,94 @@
+"""Application settings."""
+
+from __future__ import annotations
+
+from logging import getLogger
+from typing import Any, TypedDict
+
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+from django.utils.module_loading import import_string
+from slack_bolt import App
+
+from django_slack_tools.slack_messages.backends.base import BackendBase
+
+APP_SETTINGS_KEY = "DJANGO_SLACK_TOOLS"
+"Django settings key for this application."
+
+logger = getLogger(__name__)
+
+
+class AppSettings:
+    """Application settings."""
+
+    backend: BackendBase
+
+    def __init__(self, settings_dict: ConfigDict | None = None) -> None:
+        """Initialize app settings.
+
+        Args:
+            settings_dict: Settings dictionary. If `None`, try to load from Django settings (const `APP_SETTINGS_KEY`).
+                Defaults to `None`.
+
+        Raises:
+            ImproperlyConfigured: Required configuration not provided or is unexpected.
+        """
+        if not settings_dict:
+            settings_dict = getattr(settings, APP_SETTINGS_KEY, None)
+
+        if settings_dict is None:
+            msg = "Neither `settings_dict` provided or `django_slack_tools` settings found in Django settings."
+            raise ImproperlyConfigured(msg)
+
+        # Slack app
+        slack_app = settings_dict["SLACK_APP"]
+        if isinstance(slack_app, str):
+            slack_app = import_string(slack_app)
+
+        if callable(slack_app):
+            slack_app = slack_app()
+
+        if not isinstance(slack_app, App):
+            msg = "Provided `SLACK_APP` config is not Slack app."
+            raise ImproperlyConfigured(msg)
+
+        self._slack_app = slack_app
+
+        # Find backend class
+        messaging_backend = import_string(settings_dict["BACKEND"]["NAME"])
+        if not issubclass(messaging_backend, BackendBase):
+            msg = "Provided backend is not a subclass of `{qualified_path}` class.".format(
+                qualified_path=f"{BackendBase.__module__}.{BackendBase.__name__}",
+            )
+            raise ImproperlyConfigured(msg)
+
+        # Initialize with provided options
+        self.backend = messaging_backend(**settings_dict["BACKEND"]["OPTIONS"])
+
+    @property
+    def slack_app(self) -> App:
+        """Registered Slack app or `None`."""
+        return self._slack_app
+
+
+app_settings = AppSettings()
+
+
+class ConfigDict(TypedDict):
+    """Root config dict."""
+
+    SLACK_APP: App | str | None
+    "Import string to Slack app. Used for workspace-related stuffs."
+
+    BACKEND: BackendConfig
+    "Nested backend config."
+
+
+class BackendConfig(TypedDict):
+    """Backend config dict."""
+
+    NAME: str
+    "Import path to backend class."
+
+    OPTIONS: dict[str, Any]
+    "Options to pass to backend class on initialization."