Skip to content

Latest commit

 

History

History
192 lines (132 loc) · 5.12 KB

README.md

File metadata and controls

192 lines (132 loc) · 5.12 KB

git-sync

Overview

git-sync is a simple Python-based tool that automatically syncs files from a specified folder to a Git repository. It monitors the folder for changes and commits and pushes those changes to a remote Git repository, ensuring that your files are always backed up in version control. This tool can be configured to run as a service, providing seamless synchronization for your files.

Features

  • Syncs files from a local folder to a remote Git repository.
  • Watches for changes in the folder and automatically commits and pushes them.
  • Supports configuration through a config.json file.
  • Excludes unnecessary Git files (like .git/config, .git/HEAD) from triggering syncs.
  • Can be run as a background service for continuous monitoring.

Requirements

  • Python 3.x
  • Required Python packages (listed in requirements.txt)

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/git-sync.git

  2. Navigate into the project directory:

    cd git-sync

  3. Set up a virtual environment (optional but recommended):

    python3 -m venv venv
source venv/bin/activate   # On Windows, use `venv\Scripts\activate`

  4. Install the required dependencies:

    pip install -r requirements.txt

  5. Create a config.json file with the following structure:

    {
  "folders": [
    {
      "folder_to_sync": "/path/to/your/folder",
      "repo_url": "https://github.com/yourusername/yourrepo.git",
      "branch": "main",
      "commit_message": "Auto commit at {timestamp}"
    }
  ]
}
    • folder_to_sync: Path to the folder you want to sync.
    • repo_url: URL of the Git repository to push the changes.
    • branch: Git branch to push changes to.
    • commit_message: Template for the commit message (supports {timestamp} for the current time).

Usage

  1. Run the sync process:

    python -m git_sync

    This will start the monitoring of the specified folders and sync changes to the Git repository.

  2. To run the script as a service, you can set up a systemd service (for Linux) or use other appropriate methods depending on your operating system.

Explanation:

  • git_sync/: Contains the main code for the project.

    • __init__.py: Makes the folder a package.
    • __main__.py: The entry point of the application.
    • sync.py: Handles the syncing logic (commit and push).
    • watcher.py: Monitors the folder for changes.

  • requirements.txt: Lists the required Python packages.

  • config.json: Configuration file to specify the folders to sync and other settings.

  • .gitignore: Specifies which files and directories should be ignored by Git.

  • README.md: Documentation for the project.

Configuration

The configuration for git-sync is stored in the config.json file. You can add multiple folders to sync by adding them to the folders array. For each folder, provide the folder_to_sync, repo_url, branch, and commit_message.

Example config.json:

{
  "folders": [
    {
      "folder_to_sync": "/home/user/Documents/myproject",
      "repo_url": "https://github.com/yourusername/myproject.git",
      "branch": "main",
      "commit_message": "Auto commit at {timestamp}"
    }
  ]
}

Excluding Files

By default, git-sync excludes changes in Git-related files (e.g., .git/config, .git/HEAD, etc.). This is done to prevent unnecessary commits and pushes related to internal Git files.

You can modify this behavior by editing the watcher.py file if you need to include or exclude specific files.

Turning git-sync into a Daemon

To run git-sync as a background service on a Linux system, use systemd. This will allow the script to run continuously and sync your folder to the Git repository automatically.

Step 1: Create the Systemd Service File

  1. Open the terminal and create a new systemd service file:

    sudo nano /etc/systemd/system/git-sync.service

  2. Add the following content:

    [Unit]
Description=Git Sync Daemon
After=network.target

[Service]
Type=simple
User=root
Group=root
WorkingDirectory=/path/to/your/git-sync/folder
ExecStart=/bin/bash -c 'source /path/to/your/venv/bin/activate && python -m git-sync'
Restart=always

[Install]
WantedBy=multi-user.target
    • Replace /path/to/your/git-sync/folder and /path/to/your/venv with your actual paths.

Step 2: Reload systemd and Enable the Service

  1. Reload systemd to apply the new service:

    sudo systemctl daemon-reload

  2. Enable the service to start automatically on boot:

    sudo systemctl enable git-sync.service

Step 3: Start the Service

Start the service manually:

sudo systemctl start git-sync.service

Step 4: Check the Service Status

To ensure the service is running, use:

sudo systemctl status git-sync.service

Step 5: View Service Logs

To view logs for troubleshooting:

sudo journalctl -u git-sync.service

This provides a concise way to turn git-sync into a background service. Let me know if you need further modifications!