Metadata-Version: 2.5
Name: lupaxa-slackit
Version: 0.1.1
Summary: Send Slack messages through an incoming webhook.
Project-URL: Homepage, https://slackit.thelupaxaproject.org/
Project-URL: Documentation, https://slackit.thelupaxaproject.org/
Project-URL: Repository, https://github.com/lupaxa-notifications-toolbox/slackit
Project-URL: Issues, https://github.com/lupaxa-notifications-toolbox/slackit/issues
Author: The Lupaxa Project
License: MIT License
        
        Copyright (c) The Lupaxa Project
        
        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.
License-File: LICENCE
Keywords: cli,notifications,slack,webhook
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Requires-Python: >=3.13
Requires-Dist: pyyaml>=6
Requires-Dist: requests>=2.32
Provides-Extra: dev
Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
Requires-Dist: hatch>=1.12.0; extra == 'dev'
Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
Requires-Dist: mkdocs==1.6.1; extra == 'dev'
Requires-Dist: mypy>=1.12.0; extra == 'dev'
Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest>=8.0; extra == 'test'
Description-Content-Type: text/markdown

<!-- markdownlint-disable -->
<p align="center">
  <a href="https://github.com/lupaxa-notifications-toolbox">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/notifications-toolbox/readme-logo.png" alt="Project Logo" width="256"/><br/>
  </a>
</p>
<h3 align="center">
  The Lupaxa Notifications Toolbox<br />
  Part of The Lupaxa Project
</h3>

<br />

# lupaxa-slackit

Send Slack messages through an incoming webhook.

## Features

- Post message text, one attachment, or Block Kit blocks
- Set a username, channel, and icon emoji on each client
- Keep several webhook profiles in `$HOME/.slackit.yml` and select one with `--profile`
- Override any profile field with a CLI flag
- Turn escaped `\n` sequences in message text into real line breaks
- Reject webhook URLs that do not start with `https://hooks.slack.com/services/`
- Reject webhook URLs that answer `HEAD` with a redirect
- Use the `Slackit` library class or the `slackit` command

## Installation

### From PyPI

```bash
pip install lupaxa-slackit
```

### From source (development mode)

```bash
pip install -e ".[dev]"
```

Requires Python 3.13+. Runtime dependencies: `requests` and `PyYAML`.

## Library quick start

```python
from lupaxa.slackit import Slackit, load_profile

profile = load_profile("testing")
client = Slackit(
    profile.webhook_url,
    username=profile.username,
    channel=profile.channel,
    icon_emoji=profile.icon_emoji,
)
client.send_message("Hello from a profile")

client = Slackit(
    "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXX",
    username="PyBot",
    channel="#testing",
    icon_emoji=":robot_face:",
)
client.send_message("Hello, Slack!")
client.send_attachment('{"text": "Optional text inside the attachment"}')
client.send_block('[{"type": "section", "text": {"type": "mrkdwn", "text": "Hello"}}]')
```

## CLI quick start

```bash
slackit --help
slackit --webhook "$SLACK_WEBHOOK_URL" --text "Hello, Slack!"
slackit --profile testing --text "Hello, Slack!"
slackit -p alerts --config "$HOME/work/slackit.yml" --text "Disk full"
```

You can also run the CLI as a module:

```bash
python -m lupaxa.slackit --help
python -m lupaxa.slackit --version
```

## Config

Profiles live in one YAML file. The default path is `$HOME/.slackit.yml`.
Pass `--config` when the file lives somewhere else. `--config` requires
`--profile`. CLI flags override the selected profile.

```yaml
profiles:
  testing:
    webhook_url: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXX
    username: PyBot
    channel: "#testing"
    icon_emoji: ":robot_face:"
    timeout: 15
  alerts:
    webhook_url: https://hooks.slack.com/services/T00000000/B00000000/YYYYYYYY
    channel: "#alerts"
```

Each profile may set `webhook_url`, `username`, `channel`, `icon_emoji`, and
`timeout`. `--webhook` is required when you do not pass `--profile`.

## Options

- `--webhook`, `-w`: Slack incoming webhook URL; required when `--profile` is omitted
- `--profile`, `-p`: profile name in the config file
- `--config`: config file path; default `$HOME/.slackit.yml`
- `--text`, `-t`: message text
- `--attachment`, `-a`: one attachment as a JSON object
- `--blocks`, `-b`: Block Kit payload as JSON
- `--validate`: send a validation message to channel `general`
- `--username`, `-u`: display name
- `--channel`, `-c`: channel override
- `--icon-emoji`, `-i`: icon emoji
- `--timeout`, `-T`: request timeout in seconds; default `10`
- `--version`: print the package version

`--text`, `--attachment`, `--blocks`, and `--validate` are mutually exclusive.
One of them is required. CLI flags override the selected profile.

## Documentation

Online documentation:

[Documentation](https://slackit.thelupaxaproject.org/)

Source repository:

[GitHub](https://github.com/lupaxa-notifications-toolbox/slackit)

### Serve docs locally

From a clone of the repository:

```bash
make mkdocs-serve
```

Then open the local URL printed by MkDocs in your browser.

## Development

Clone the repository and install with Make:

```bash
make init                # first-time makefile-skills checkout
make python-install-dev  # editable install with [dev]
make python-check        # lint, type-check, and test
```

<a href="https://github.com/the-lupaxa-project">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
</a>
