Skip to main content

Diary bot using git repo as a primary storage

Project description

Telegram bot, that writes incoming messages to a text file and synchronizes using Git repository. In addition to plain text input it also understands locations, voice recordings and photos.

The bot is meant to be self-hosted. Demo bot is running in multi-user mode and can be used for trial.

Decisions and Trade-offs


I want to keep a private journal/diary. I post there what’s important for me at the moment. Sometimes I reorganize the content, edit old records. I don’t want to share any part of it.


GitDiaryBot has to be:

  1. Private - no third party should be able to the diary, or control it.

  2. Simple - no special software should be needed to read/write the records.

  3. Reliable - network/hard drive failures should not result in lost or unsaved records.

  4. Independent - supports self-hosted server side, private repositories.


GitDiaryBot is designed from three assumptions:

  1. Diary is a single plain text file, that grows by appending records.

  2. Git is used for synchronization and backup.

  3. New records come from messages to a chat bot.

While each part can be replaced, the primary goal is to have this combination working.

OOP Architecture

Dispatcher is reacting to Telegram.Bot updates by delegating to 2 classes:

  1. Installer

  2. Receiver

Receiver attempts to load tenant using effective user ID from incoming update. If tenant does not exists, Dispatcher calls Installer to run installation flow.

For successfully loaded Tenant, Dispatcher calls Receiver which extracts GitDiaryBot Events from Telegram Update Message and invokes appropriate handler.

Handlers processes Events using Core classes.

Core classes’ responsibilities are:

  • Save journaling records.

  • Synchronize with upstream.

  • Transcribe voice.

  • Geocode coordinates.

  • Annotate photos.

Core classes are not allowed to import anything outside core directory.

Transformers use core classes to extract plain text records from other media.

Skill combines telegram filter, extractor, event type and handler. Skillset defines capabilities available to a Tenant.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

GitDiaryBot-0.0.1.tar.gz (17.5 kB view hashes)

Uploaded Source

Built Distribution

GitDiaryBot-0.0.1-py2.py3-none-any.whl (23.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page