Skip to content

vvilip/wikibot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wikibot

A simple Matrix bot that summarizes the daily featured Wikipedia article in a concise and engaging manner.

Features:

  • Summarization: Automatically generates a short, engaging summary of a Wikipedia article.

  • Focus on Essentials: Keeps the most important and unique aspects of the topic, while omitting technical jargon, lengthy descriptions, and minor facts.

  • Customizable Output: You can tweak the prompt to fine-tune the summarization process.

How It Works:

  1. The tool fetches the daily featured Wikipedia article

  2. The fetched article gets summarized by an LLM

  3. The summarization gets sent via Matrix to any chatroom

Get the image :

docker pull ghcr.io/vvilip/wikibot:latest

Run it locally:

  1. Create an account at Wikimedia
  2. For authentication create a client secret & id
  3. Create an account at Ollama Cloud
  4. Get yourself an API key
  5. Set all the env variables correctly:
Name Description Example Value
CLIENT_ID The client id from wikimedia -
CLIENT_SECRET The client secret from wikimedia -
MATRIX_HOSTNAME The hostname of your matrix server matrix.yourserver.com
MATRIX_USERNAME The username of your matrix bot account cool bot
MATRIX_PASSWORD The password of your matrix bot account some password
MATRIX_ROOM_ID The room id in which the bot should write -
OLLAMA_API_KEY The API key from Ollama Cloud ollama_...
OLLAMA_MODEL_NAME The Ollama model to use (optional) llama3.2
OLLAMA_BASE_URL The Ollama API base URL (optional) https://ollama.com/api
CRON_EXPR An unix cron expression for when the bot
is supposed to send the message
0 10 * * * (for 10 am every day)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages