https://github.com/rudeigerc/scrapy-slackbot

A Scrapy extension for sending notification to Slack channels
https://github.com/rudeigerc/scrapy-slackbot

scrapy-extension slack-bot

Last synced: about 1 month ago
JSON representation

A Scrapy extension for sending notification to Slack channels

• Host: GitHub
• URL: https://github.com/rudeigerc/scrapy-slackbot
• Owner: rudeigerc
• License: mit
• Created: 2018-06-26T12:39:11.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2022-11-29T09:14:24.000Z (over 2 years ago)
• Last Synced: 2025-03-30T02:22:29.627Z (about 2 months ago)
• Topics: scrapy-extension, slack-bot
• Language: Python
• Homepage:
• Size: 108 KB
• Stars: 9
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# scrapy-slackbot

[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)

[![pypi](https://img.shields.io/pypi/v/scrapy-slackbot)](https://pypi.org/project/scrapy-slackbot/)

[![LICENSE](https://img.shields.io/github/license/rudeigerc/scrapy-slackbot.svg)](https://github.com/rudeigerc/scrapy-slackbot/blob/master/LICENSE)

A [Scrapy](https://scrapy.org/) extension for sending notification to Slack channels.

## Installation

```shell

$ pip install scrapy-slackbot

```

## Settings

In `settings.py`:

```python

EXTENSIONS = {

    'scrapyslackbot.extensions.SlackBot': 500,

}

SLACK_ENABLED = True

SLACK_BOT_TOKEN = ''

SLACK_CHANNEL = ''

```

### SLACK_ENABLED

A boolean which specifies whether the bot is enabled.

### SLACK_BOT_TOKEN

`Bot User OAuth Access Token` generated by **Slack**.

Follow the instructions of [Slack API](https://api.slack.com/slack-apps), visit `Features > OAuth & Permissions` and generate the token.

### SLACK_CHANNEL

The ID of the channel in your workspace.

## Development

We use [PDM](https://pdm.fming.dev/) as the package and dependency manager. Please make sure you have installed PDM at first.

```shell

$ pdm install

```

## Demo

![demo](docs/assets/demo.jpg)

## License

The project is licensed under the MIT License.