gitchat 0.0.5

Proof-of-work realtime chat, using only `git` as a transport

GitChat

Proof-of-work realtime chat, using only git as a transport

This is just a joy project, be careful!

Requirements

• Git
• Python >= 3.12
• Github/Gitlab/Gitverse account

Usage

1. Install package

# From PyPI
pip install gitchat

# From source
git clone <this repo>
cd gitchat
pip install .

2. Create empty git repo using any git hosting and clone it

# You should also register git credentails
gitchat login -u my_login -p my_password -r github.com -c ~/.git-credentials

3. Configure peers once (on both sides) and enter chat:

# Configuring repo
gitchat config -r <repo path> -u <username>

# Starting chat
gitchat chat -r <repo path> -u <username> -d <check interval in secs>

4. Add handler (to process messages)

# handler.py (example)
import os

def handler(message):
    if message["data"].startswith("%sh"):
        cmd = message["data"][4:]
        print(f"[*] Executing '{cmd}' ...")
        os.system(cmd)

# In shell
gitchat chat -u <username> -r <repo path> --handler handler.py

your py file must have function handler that accepts message

5. Enable encryption

# Use the same password on both sides!
gitchat chat -u <username> -r <repo path> -p "strong password"

TODO

• Manager for configuration (to make it available via code)
• MessageProtocol to define message structure
• Enable file sharing mechanism