Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add SMIB summary to readme. Fixes #149 #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sjefferson99 merged 2 commits into from
Jun 20, 2024
Merged

Add SMIB summary to readme. Fixes #149 #156

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02eb237
Add SMIB summary to readme. Fixes #149
sjefferson99 Jun 16, 2024
cef26f7
refactor: Update SMIB and SMIB Commands links in README.md
sjefferson99 Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
## Python Version
Python 3.12.3
# SMIB (So Make It Bot)
## Introduction
SMIB is the So Make It Bot. The architecture is a set of docker containers configured to work together, that can run on a pi4 or similar and provide slack bot interactivity with a maker space (or any space).

### Features
- A socket mode slack bot server that requires no port forwarding or firewall config to get going on your network.
- Web server with plugin architecture providing a REST API with swagger API documentation, so you can write your own plugins that can be called by REST API and executed by the slack bot - allows creating web pages or local devices (such as SMIBHID) that drive the slack bot without the need for leaving the local network.
- Stateful database storage for storing information like space state for coordination among multiple bots/endpoints.
- SMIBHID (SMIB Human Interface Device) - A Pi Pico based interface device that provides buttons, displays and any other human interface to the slack bot via the REST API. See the [SMIBHID docs](smibhid/README.md) for more information.

## Docker deployment
### Supported Python Version
Python 3.12.3

### Installation
- Clone the repository to your target server host
- Install docker if not already present
Expand Down Expand Up @@ -73,13 +83,13 @@ Further documentation can be found [in the smibhid folder](smibhid/).
## Legacy SMIB Commands
Currently, the old [SMIB Commands](https://github.com/somakeit/smib-commands) do not work with the new SMIB.

The old [SMIB](https://github.com/somakeit/smib) worked using the Slack RTM api. This API has been replaced with the Events API.
The old [SMIB](https://github.com/somakeit/smib-old) worked using the Slack RTM API. This API has been replaced with the Events API.

Previously, SMIB Commands were created as the only way to interact with SMIB.

I think some form of backwards compatibility or similar functionality would be good. Work on a `ShellPluginLoader` was started but parked as it was not the main focus of the new amped up SMIB [MVP](https://en.wikipedia.org/wiki/Minimum_viable_product)

An [issue](https://github.com/somakeit/S.M.I.B./issues/83) has been created to track the progress and gather ideas.
An [issue](https://github.com/somakeit/smib/issues/83) has been created to track the progress and gather ideas.

## Version
When bumping the poetry version (in pyproject.toml), the `HID` class (part of SMIBHID) `version` attribute also needs manually updating.
Expand Down