Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slashtechno/tldscroll
A Slack bot that helps you to summarize long messages and threads.
https://github.com/slashtechno/tldscroll
ollama slack
Last synced: 4 months ago
JSON representation
A Slack bot that helps you to summarize long messages and threads.
- Host: GitHub
- URL: https://github.com/slashtechno/tldscroll
- Owner: slashtechno
- License: mit
- Created: 2024-08-21T22:00:49.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T03:50:17.000Z (5 months ago)
- Last Synced: 2024-09-30T05:19:02.955Z (4 months ago)
- Topics: ollama, slack
- Language: Python
- Homepage:
- Size: 29.3 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Too Long; Didn't Scroll (TL;DS)
A Slack bot that helps you to summarize long messages and threads.
[](tlds-demo_2024-08-22_19-24-01.mp4)
### Features
* Summarize messages and threads
* Running on a top-level message will summarize the message along with its replies, if any exist
* Running on a reply will summarize the reply
* Summarize messages and threads with a single click (well, two clicks)
* Use the `Generate Summary` message action to summarize
* Customizable visibility
* When using the `/tlds` command, you can choose whether the summary is visible to everyone or is ephemeral and only visible to you
* When using the `Generate summary` message action, the summary is ephemeral and only visible to you
* When using the `Generate public summary` message action, the summary is visible to everyone
* Customizable LLM model and provider
* Supports [Ollama](https://ollama.com/) for local/on-premises summarization
* Supports OpenAI-compatible APIs for cloud-based summarization
* Examples include [OpenAI](https://openai.com/) and [OpenRouter](https://openrouter.ai/)
* A help command (`/tlds-help`) to show the available commands and options
### Setup
1. Create a new Slack app at [api.slack.com/apps](https://api.slack.com/apps)
2. Use the `manifest.yml` file to create it
3. Install the app to your workspace
4. Clone the repository
5. Copy the `example.env` file to `.env` and fill in the values
* Alternatively, you can use `.secrets.toml` and `settings.toml`
* For more information, check the `example.*.toml` files
#### Running the server
##### Docker
Run the following command to build and run the Docker container:
```sh
docker-compose up
```
If you want to run the container in the background, use the `-d` flag:
```sh
docker-compose up -d
```
If you have Ollama running on the host, the host can be accessed by the container by using `host.docker.internal` as the host name. For example, if Ollama is running on port `11434` (the default), setting the `base_url` to `http://host.docker.internal:11434` will allow the container to access Ollama.
The `docker-compose.yml` file also has a commented-out section for Ollama that can be used. However, setting it up on the host or by itself can offer more flexibility. To use the Ollama section in the `docker-compose.yml` file, uncomment the section. The `base_url` should be `http://ollama:11434` in this case.
##### Poetry
If you want to run the server without Docker, you can use [Poetry](https://python-poetry.org/):
```sh
poetry install
poetry run python -m tlds
```
### Usage
1. Add the app to channel(s) where you want it to be able to summarize messages from
2. Use the `/tlds` command or the `Generate Summary`/`Generate public summary` message actions to summarize messages and threads