Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/entur/officeplanner
This python script posts a message in multiple slack channels, and responds to the same message with 5 emojies that represent the weekdays.
https://github.com/entur/officeplanner
office planning self-hosted
Last synced: about 2 months ago
JSON representation
This python script posts a message in multiple slack channels, and responds to the same message with 5 emojies that represent the weekdays.
- Host: GitHub
- URL: https://github.com/entur/officeplanner
- Owner: entur
- License: eupl-1.2
- Created: 2022-06-08T10:35:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T12:54:23.000Z (5 months ago)
- Last Synced: 2024-08-06T13:08:55.599Z (5 months ago)
- Topics: office, planning, self-hosted
- Language: Python
- Homepage:
- Size: 43.9 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
Awesome Lists containing this project
README
# Slack team location planner
We created a simple solution for getting a overview for planning when people in the team are coming into the office, without the need to introduce any new tools or complex 3rd-party slack applications.
This python script posts a message in multiple slack channels, and responds to the same message with 5 emojies that represent the weekdays.
The application is self-hosted and uses a Slack bot token, cron jobs can be created from CI tools like Github Actions / CircleCI Cron, run as a Kubernetes cron job or just be run locallly with python/docker.
## Onbarding
To add a new channel:
- Type `/invite atoffice` in the channel to grant permissions to the bot.
- Create a new PR.
- Enter channel name in `channels.txt`, create commit.
- Merge PR to main.
## Slack Bot configuration
You need to create a Slack app yourself at https://api.slack.com/apps/
Create a new Slack app, customize it as you prefer.
The bot requires the following **bot token scopes**:
- `chat:write`
- `reactions:write`
Install the bot to you slack organization after setting permissions, you will get a new slack bot token afterwards.
## Using the script
As a pre-requsite, you'll need to have 5 custom emojies representing each day in your slack organization. Without the emojies defined in the list below, the script will fail.
- `:monday:`
- `:tuesday:`
- `:wednesday:`
- `:thursday:`
- `:friday:`
> Example emojies can be found under the `examples/` folder.
To run the script you need two things, a `.txt` file containing name of the slack channels and a environment variable for the bot token.
#### Python
If you are using python, then a `channels.txt` file should exist next to the `officeplanner.py` script and the `SLACK_BOT_TOKEN` must be populated in the same shell as the one running python.
#### Docker
The latest docker image is available on github packages, and is updated when a PR is pushed to the `main` branch.
```
ghcr.io/entur/officeplanner:main
```
Mount a `.txt` file to `/app/channels.txt` in the docker container.
Populate a `SLACK_BOT_TOKEN` environment variable with the token you got when creating the slack app.