Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/farrajota/design-patterns-slackbot
Send random design patterns to your slack channel.
https://github.com/farrajota/design-patterns-slackbot
design-patterns python slackbot
Last synced: about 12 hours ago
JSON representation
Send random design patterns to your slack channel.
- Host: GitHub
- URL: https://github.com/farrajota/design-patterns-slackbot
- Owner: farrajota
- License: mit
- Created: 2021-04-11T21:27:53.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-05-03T07:55:55.000Z (over 3 years ago)
- Last Synced: 2023-10-20T12:34:43.432Z (about 1 year ago)
- Topics: design-patterns, python, slackbot
- Language: Python
- Homepage:
- Size: 332 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Design Patterns
Send random design patterns to your slack for you or your teammates to see.
The motivation for making this is due to the existence of dozens and dozens of design patterns one can [find in the wild](https://github.com/DovAmir/awesome-design-patterns#cloud-architecture) but you have no idea of their existence but still you would like to learn more about to enrich your knowledge and toolkit.
This repo provides a tool to easily ingest this kind of information by providing a summarized view of the patterns which you can learn more about and share it with your friends.
> Note: This repo is slowly being updated but if you would like to contribute, feel free to make a pull request and I'll gladly review it.
## Requirements
- Python 3.6+
- Slack API key
- Slack channel
# Usage - Slack
To send a message, first set `SLACK_API_KEY` and `SLACK_CHANNEL` as environment variables with the api key and channel to send messages to.
```bash
export SLACK_API_KEY="xxxx-xxxxxxxx-xxxxxxxxxx-xxxxxxxxxxxxxxxxx"
export SLACK_CHANNEL="#monitoring-testing"
```
Then, to send a message with a random pattern just run the following script:
```bash
python slackbot/send_messages.py --random
```
You should see some message like the following:
Additionally, to generate a random list of messages that will not be repeated and to send a single message do the following:
```bash
python slackbot/send_messages.py # sends a message to slack
python slackbot/send_messages.py # sends a different message
python slackbot/send_messages.py # send another different one
```
> Idea: Setup a cronjob to send random messages to slack every morning to your team to share this knowledge.
# Patterns
## Cloud Architecture
- [Azure cloud design patterns](cloud_design_patterns/README.md)
## TODO
- Add patterns:
- [general architecture](https://github.com/DovAmir/awesome-design-patterns#general-architecture)
- [Cloud architecture](https://github.com/DovAmir/awesome-design-patterns#cloud-architecture)
# References
- https://github.com/DovAmir/awesome-design-patterns#cloud-architecture
# License
[MIT License](LICENSE)