Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flaconi/slackbot-pagey

Pagey is a Pagerduty slack bot.
https://github.com/flaconi/slackbot-pagey

Last synced: about 4 hours ago
JSON representation

Pagey is a Pagerduty slack bot.

Awesome Lists containing this project

README

        

# Pagey

**TL;DR:** Pagey is a Pagerduty slack bot.

[![](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI](https://img.shields.io/pypi/v/pagey)](https://pypi.org/project/pagey/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pagey)](https://pypi.org/project/pagey/)
[![PyPI - Format](https://img.shields.io/pypi/format/pagey)](https://pypi.org/project/pagey/)
[![PyPI - Implementation](https://img.shields.io/pypi/implementation/pagey)](https://pypi.org/project/pagey/)
[![PyPI - License](https://img.shields.io/pypi/l/pagey)](https://pypi.org/project/pagey/)

## :hourglass: Pipelines

[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/linting/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=linting)
[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/building/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=building)
[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/pypi/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=pypi)
[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/testing/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=testing)

[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/black/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=black)
[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/bandit/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=bandit)
[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/mypy/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=mypy)
[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/pylint/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=pylint)
[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/pycode/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=pycode)
[![Build Status](https://github.com/Flaconi/slackbot-pagey/workflows/pydoc/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions?workflow=pydoc)

## :tada: Install
```bash
pip install pagey
```

> :exclamation: Requires Python >= 3.8

## :computer: Usage
```bash
# Export required tokens to your env
export PAGEY_SLACK_TOKEN="read-write slack token"
export PAGEY_PD_TOKEN="read-only pagerduty token"

# Run it
pagey
```

## Docker

[![docker](https://github.com/Flaconi/slackbot-pagey/actions/workflows/docker.yml/badge.svg)](https://github.com/Flaconi/slackbot-pagey/actions/workflows/docker.yml)

Docker image is available here:

[![Docker hub](http://dockeri.co/image/flaconi/slackbot-pagey?&kill_cache=1)](https://hub.docker.com/r/flaconi/slackbot-pagey)

```bash
# Export required tokens to your env
export PAGEY_SLACK_TOKEN="read-write slack token"
export PAGEY_PD_TOKEN="read-only pagerduty token"

# Run it
docker run --rm -d -e PAGEY_SLACK_TOKEN -e PAGEY_PD_TOKEN flaconi/slackbot-pagey
```

## Slack configuration

See [doc/](doc/) directory for how to configure Slack

## :page_facing_up: License

**[MIT License](LICENSE.txt)**

Copyright (c) 2021-2024 **[Flaconi](https://github.com/Flaconi)**