django-slack-tools 0.2.2__tar.gz → 0.3.0__tar.gz

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/.devcontainer/devcontainer.json

@@ -9,7 +9,7 @@
     "ghcr.io/devcontainers/features/docker-in-docker:2": {}
   },
   "onCreateCommand": "./.devcontainer/onCreateCommand.sh",
-  "updateContentCommand": "make install",
+  "postAttachCommand": "make install",
   "customizations": {
     "vscode": {
       "extensions": [

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/.github/dependabot.yaml

@@ -1,12 +1,13 @@
 # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
 version: 2
+enable-beta-ecosystems: true
 updates:
   - package-ecosystem: github-actions
     directory: /
     schedule:
       interval: monthly
 
-  - package-ecosystem: pip
+  - package-ecosystem: uv
     directory: /
     schedule:
       interval: monthly

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/.github/workflows/ci.yaml

@@ -8,6 +8,9 @@ on:
 
 permissions: read-all
 
+env:
+  UV_FROZEN: 1
+
 jobs:
   lint:
     name: Lint
@@ -17,13 +20,13 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           version: latest
           enable-cache: true
 
       - name: Install deps
-        run: uv sync --frozen --all-extras
+        run: uv sync --all-extras
 
       - uses: pre-commit/action@v3.0.1
         env:
@@ -35,15 +38,15 @@ jobs:
   test:
     name: Test (Python ${{ matrix.python-version }}, Django ${{ matrix.django-version }})
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
     strategy:
       fail-fast: false
       matrix:
         python-version: ["3.10", "3.11", "3.12"]
         django-version: ["4.2", "5.0", "5.1"]
         include:
-          - python-version: "3.8"
-            django-version: "4.2"
-
           - python-version: "3.9"
             django-version: "4.2"
 
@@ -55,7 +58,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           version: latest
           enable-cache: true
@@ -64,31 +67,32 @@ jobs:
         run: uv python pin "${{ matrix.python-version }}"
 
       - name: Install deps
-        run: uv sync --frozen --all-extras
+        run: uv sync --all-extras
 
       - name: Install Django
         run: uv pip install Django=="${{ matrix.django-version }}.*"
 
       - name: Run tests
-        run: uv run --frozen pytest
+        run: uv run nox
 
       - name: Upload test results to Codecov
-        uses: codecov/test-results-action@v1
+        uses: codecov/codecov-action@v5
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          use_oidc: true
           fail_ci_if_error: false
+          report_type: test_results
           files: junit.xml
           flags: >-
             python-${{ matrix.python-version }},
             django-${{ matrix.django-version }}
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         env:
           PYTHON: ${{ matrix.python-version }}
           DJANGO: ${{ matrix.django-version }}
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          use_oidc: true
           fail_ci_if_error: false
           files: coverage.xml
           env_vars: PYTHON,DJANGO

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/.github/workflows/docs.yaml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           version: latest
           enable-cache: true

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/.github/workflows/release.yaml

@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           version: latest
           enable-cache: true
@@ -47,6 +47,7 @@ jobs:
       - release
     permissions:
       id-token: write
+    environment: pypi
     steps:
       - name: Retrieve release distributions
         uses: actions/download-artifact@v4

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/.pre-commit-config.yaml

@@ -11,7 +11,12 @@ repos:
     rev: v0.3.0
     hooks:
       - id: check-directory-structure
-        args: [--source, django_slack_tools, --extend-exclude, '**/migrations/*.py']
+        args:
+          - --source
+          - django_slack_tools
+          - --extend-exclude
+          - '**/migrations/*.py'
+          - '**/errors.py'
 
   - repo: local
     hooks:

django_slack_tools-0.3.0/.python-version

@@ -0,0 +1 @@
+3.9

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/.vscode/settings.json

@@ -42,6 +42,7 @@
   "python.testing.pytestEnabled": true,
   "python.testing.pytestArgs": [
     "--no-cov", // https://code.visualstudio.com/docs/python/testing#_pytest-configuration-settings
+    "-vv"
   ],
   "autoDocstring.docstringFormat": "google-notypes"
 }

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/Makefile

@@ -38,6 +38,14 @@ serve-docs:  ## Serve dev documents
 		--dev-addr $$([ ! -z "$${CONTAINER:-}" ] && echo '0.0.0.0:8000' || echo '127.0.0.1:8000')
 .PHONY: serve-docs
 
+makemessages:  ## Update translation files
+	uv run python manage.py makemessages --all --ignore 'examples/*' --no-obsolete
+.PHONY: makemessages
+
+compilemessages:  ## Compile translation files
+	uv run python manage.py compilemessages --ignore 'examples/*'
+.PHONY: compilemessages
+
 
 # =============================================================================
 # CI

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/PKG-INFO

@@ -1,16 +1,19 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: django-slack-tools
-Version: 0.2.2
+Version: 0.3.0
 Summary: Little helpers working with Slack bot 🤖 in Django.
 Author-email: Yuchan Lee <lasuillard@gmail.com>
-Requires-Python: <4.0,>=3.8
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: <4.0,>=3.9
 Requires-Dist: django<5.2,>=4.2
+Requires-Dist: pydantic<3,>=2
 Requires-Dist: slack-bolt<2,>=1
 Requires-Dist: xmltodict<1,>=0.14.1
 Provides-Extra: celery
 Requires-Dist: celery<6,>=5; extra == 'celery'
 Provides-Extra: dev
-Requires-Dist: django-debug-toolbar~=4.4; extra == 'dev'
+Requires-Dist: django-debug-toolbar<6.0,>=4.4; extra == 'dev'
 Requires-Dist: django-extensions~=3.2; extra == 'dev'
 Requires-Dist: django-stubs[compatible-mypy]~=5.1; extra == 'dev'
 Requires-Dist: ipykernel~=6.27; extra == 'dev'
@@ -23,8 +26,9 @@ Provides-Extra: test
 Requires-Dist: coverage~=7.3; extra == 'test'
 Requires-Dist: django-coverage-plugin~=3.1; extra == 'test'
 Requires-Dist: factory-boy~=3.3; extra == 'test'
-Requires-Dist: faker~=30.3; extra == 'test'
-Requires-Dist: pytest-cov~=5.0; extra == 'test'
+Requires-Dist: faker<37.0,>=30.3; extra == 'test'
+Requires-Dist: nox<2025.3.0,>=2024.10.9; extra == 'test'
+Requires-Dist: pytest-cov<7,>=5; extra == 'test'
 Requires-Dist: pytest-django~=4.9; extra == 'test'
 Requires-Dist: pytest-sugar~=1.0; extra == 'test'
 Requires-Dist: pytest-xdist~=3.6; extra == 'test'
@@ -66,61 +70,9 @@ And more in future roadmap...
 
 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
+## 🗞️ Documentation
 
-**django-slack-tools** supports Python 3.8+ and Django 4.2+. Supports for each deps will be dropped as soon as the ends of security updates.
-
-> [!WARNING]
-> 0.x versions are for development. Breaking changes can be made at any time. If gonna use this package, recommend to pin down the version.
-
-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.
+Please check the [documentation](https://lasuillard.github.io/django-slack-tools/) for more details.
 
 ## 💖 Contributing
 

{django_slack_tools-0.2.2 → django_slack_tools-0.3.0}/README.md

@@ -33,61 +33,9 @@ And more in future roadmap...
 
 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
+## 🗞️ Documentation
 
-**django-slack-tools** supports Python 3.8+ and Django 4.2+. Supports for each deps will be dropped as soon as the ends of security updates.
-
-> [!WARNING]
-> 0.x versions are for development. Breaking changes can be made at any time. If gonna use this package, recommend to pin down the version.
-
-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.
+Please check the [documentation](https://lasuillard.github.io/django-slack-tools/) for more details.
 
 ## 💖 Contributing
 

django_slack_tools-0.3.0/django_slack_tools/app_settings.py

@@ -0,0 +1,87 @@
+"""Application settings."""
+# flake8: noqa: UP007
+
+from __future__ import annotations
+
+from logging import getLogger
+from typing import TYPE_CHECKING, 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 typing_extensions import NotRequired, Self
+
+from django_slack_tools.utils.import_helper import LazyInitSpec, lazy_init
+
+if TYPE_CHECKING:
+    from django_slack_tools.slack_messages.messenger import Messenger
+
+logger = getLogger(__name__)
+
+
+class SettingsDict(TypedDict):
+    """Dictionary input for app settings."""
+
+    slack_app: str
+    messengers: NotRequired[dict[str, LazyInitSpec]]
+
+
+class AppSettings:
+    """Application settings."""
+
+    slack_app: App
+    messengers: dict[str, Messenger]
+
+    def __init__(self, slack_app: App, messengers: dict[str, Messenger]) -> None:  # noqa: D107
+        if not isinstance(slack_app, App):
+            msg = f"Expected {App!s} instance, got {type(slack_app)}"
+            raise TypeError(msg)
+
+        self.slack_app = slack_app
+        self.messengers = messengers
+
+    @classmethod
+    def from_dict(cls, settings_dict: SettingsDict) -> Self:
+        """Initialize settings from a dictionary."""
+        try:
+            slack_app = import_string(settings_dict["slack_app"])
+            messengers = {
+                name: cls._create_messenger(spec) for name, spec in settings_dict.get("messengers", {}).items()
+            }
+            return cls(
+                slack_app=slack_app,
+                messengers=messengers,
+            )
+        except Exception as err:
+            msg = f"Couldn't initialize app settings: {err!s}"
+            raise ImproperlyConfigured(msg) from err
+
+    @classmethod
+    def _create_messenger(cls, spec: LazyInitSpec) -> Messenger:
+        class_ = import_string(spec["class"])
+        args, kwargs = spec.get("args", ()), spec.get("kwargs", {})
+
+        # Lazy-init all the things
+        kwargs = kwargs.copy()
+        kwargs["template_loaders"] = [lazy_init(tl) for tl in kwargs["template_loaders"]]
+        kwargs["middlewares"] = [lazy_init(tl) for tl in kwargs["middlewares"]]
+        kwargs["messaging_backend"] = lazy_init(kwargs["messaging_backend"])
+
+        # Create the messenger
+        return class_(*args, **kwargs)  # type: ignore[no-any-return]
+
+
+def get_settings_from_django(settings_key: str = "DJANGO_SLACK_TOOLS") -> AppSettings:
+    """Get application settings."""
+    django_settings: SettingsDict = getattr(settings, settings_key)
+    return AppSettings.from_dict(django_settings or {})
+
+
+app_settings = get_settings_from_django()
+
+
+def get_messenger(name: str | None = None) -> Messenger:
+    """Get a messenger instance by name."""
+    name = name or "default"
+    return app_settings.messengers[name]