gitloom 0.1.0

GitLoom syncs files and folders to a GitHub repository and keeps them updated.

GitLoom

GitLoom is a Python tool and library that syncs a local folder to a GitHub repository and keeps it updated. It watches for file changes and automatically commits + pushes updates when you save files.

Features

• Initialize or connect a folder to a GitHub repo
• One-shot syncs for CI or manual runs
• Continuous watch mode with auto-commit and auto-push
• Configurable commit messages, branch, and ignore patterns

Requirements

• Python 3.9+
• git installed and available on your PATH
• GitHub repository access (SSH key or HTTPS token)

Installation

pip install gitloom

Quick start

# Initialize and connect a folder to a GitHub repo
gitloom init --repo-path . --remote [e-mail]:your-org/your-repo.git

# One-time sync
gitloom sync --repo-path .

# Watch for changes and auto-sync
gitloom watch --repo-path .

CLI commands

gitloom init

Initializes a git repository (if missing) and sets the remote.

gitloom init --repo-path /path/to/folder --remote [e-mail]:your-org/repo.git --branch main

gitloom sync

Stages, commits, and pushes any changes.

gitloom sync --repo-path /path/to/folder --message "Auto-sync" --branch main

gitloom watch

Runs a file watcher and syncs on changes.

gitloom watch --repo-path /path/to/folder --message "Auto-sync" --branch main

Library usage

from gitloom.sync import sync_once, watch

sync_once(repo_path=".", remote_url="[e-mail]:your-org/repo.git")

watch(repo_path=".", remote_url="[e-mail]:your-org/repo.git")

Configuration

You can pass options via CLI flags or library arguments:

• repo_path: local folder to sync
• remote_url: GitHub repository URL
• branch: branch to push to
• commit_message: message used for auto-commits
• ignore: list of glob patterns to ignore

License

MIT License. See LICENSE.