https://github.com/dy0gu/slack-ring-bot
Slack bot that posts Ring camera recordings to a channel whenever someone presses the doorbell.
https://github.com/dy0gu/slack-ring-bot
ring slack
Last synced: 2 months ago
JSON representation
Slack bot that posts Ring camera recordings to a channel whenever someone presses the doorbell.
- Host: GitHub
- URL: https://github.com/dy0gu/slack-ring-bot
- Owner: dy0gu
- Created: 2025-11-14T21:57:44.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-11-15T16:58:26.000Z (7 months ago)
- Last Synced: 2025-12-26T19:42:56.977Z (6 months ago)
- Topics: ring, slack
- Language: Python
- Homepage: https://hub.docker.com/r/dy0gu/slack-ring-bot
- Size: 22.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Ring Ring 🔔💬
Slack bot that listens to Ring doorbell events and automatically sends video recordings to your Slack team channel. Built with the unofficial (reverse-engineered) [python-ring-doorbell](https://github.com/python-ring-doorbell/python-ring-doorbell) API library.
**NOTE:** At the moment you need to have at least a basic Ring subscription (the cheapest plan) assigned to the device you want to get video clips from. Otherwise, the bot won't be able to retrieve any recordings.
## Development 🛠️
- ### Requirements 📋
- Python ([version](pyproject.toml#L4))
- ### Setup ⚙️
- Clone the repository and open a terminal **inside** it.
- Install the dependencies:
```shell
# Creating a virtual environment is recommended before installing any project dependencies!
pip install .
```
- Create a `.env` file based on the [`.env.example`](.env.example) file.
- Be aware that while Ring's authentication gives some leeway for code validity, you'll have to quickly start the bot after
setting up the Ring OTP environment variable. If you don't have Ring 2FA enabled you **still** need to set this variable, but it can be any value, you won't need to worry about it.
- Start the app:
```shell
python src/bot.py
```
- Alternatively, you can also force the build property of the provided `docker-compose.yaml` to run, allowing you to test the
Docker setup in development:
```shell
docker compose up --build
```
- ### Tooling 🧰
- Ruff is used as a linter and formatter:
```shell
pip install .[check]
ruff check --fix
ruff format
# To automatically lint and format on every commit install the pre-commit hooks:
pre-commit install
# When using pre-commit hooks, commits may fail if files with errors are checked.
# Changed files must be added to the staged area and commited again to apply fixes.
# If you run into any issues just manually run the linter commands above to address them.
```
## Deployment 🚀
The bot is designed to run continuously as a Docker container.
- Supply the [required environment variables](.env.example) when running the container, just like in development.
- Start the container, e.g using the provided `docker-compose.yaml`:
```shell
docker compose up
```
- Serve it using your server configuration of choice!