working code for gh-fork-sync

Author: shripadbpersonal

.github/workflows/python-app.yml

@@ -0,0 +1,28 @@
+name: Python application
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        flake8 gh_fork_sync.py

.gitignore

@@ -0,0 +1,3 @@
+__pycache__/
+*.pyc
+.env

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shripad Bankar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell    
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:                     
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.                              
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER        
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
+SOFTWARE.

README.md

@@ -0,0 +1,33 @@
+# 🔄 GitHub Fork Sync
+
+[![Python](https://img.shields.io/badge/Python-3.x-blue.svg)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Sync your forked GitHub repository with the upstream/original repo using one command.
+
+## 🚀 Features
+
+- Automatically adds the `upstream` remote (if not present)
+- Fetches updates from upstream
+- Merges/rebases upstream into your fork's main branch
+- Pushes changes to your GitHub fork
+
+## 📦 Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+## 🛠️ Usage
+
+```bash
+python gh_fork_sync.py --repo owner/repo --token YOUR_GITHUB_TOKEN
+```
+
+**Options:**
+- `--branch`: Branch to sync (default: main)
+- `--method`: Merge or rebase (default: merge)
+
+## 📄 License
+
+MIT License

gh_fork_sync.py

@@ -0,0 +1,48 @@
+import argparse
+import subprocess
+import os
+from git import Repo, GitCommandError
+
+def sync_fork(repo_path, remote_url, branch="main", method="merge"):
+    try:
+        repo = Repo(repo_path)
+        origin = repo.remotes.origin
+        if "upstream" not in [r.name for r in repo.remotes]:
+            upstream_url = f"https://github.com/{remote_url}.git"
+            repo.create_remote("upstream", upstream_url)
+            print(f"Added upstream: {upstream_url}")
+
+        upstream = repo.remotes.upstream
+        upstream.fetch()
+        print(f"Fetched upstream/{branch}")
+
+        repo.git.checkout(branch)
+
+        if method == "merge":
+            repo.git.merge(f"upstream/{branch}")
+            print(f"Merged upstream/{branch} into {branch}")
+        else:
+            repo.git.rebase(f"upstream/{branch}")
+            print(f"Rebased {branch} with upstream/{branch}")
+
+        origin.push()
+        print("Pushed changes to origin.")
+
+    except GitCommandError as e:
+        print(f"Git error: {e}")
+    except Exception as ex:
+        print(f"Error: {ex}")
+
+def main():
+    parser = argparse.ArgumentParser(description="Sync fork with upstream")
+    parser.add_argument("--repo", required=True, help="Repo path in format 'owner/repo'")
+    parser.add_argument("--token", help="GitHub token (not used in local-only operations)")
+    parser.add_argument("--branch", default="main", help="Branch to sync (default: main)")
+    parser.add_argument("--method", choices=["merge", "rebase"], default="merge", help="Sync method (merge or rebase)")
+    parser.add_argument("--local", default=".", help="Local path to the fork repo")
+    args = parser.parse_args()
+
+    sync_fork(args.local, args.repo, args.branch, args.method)
+
+if __name__ == "__main__":
+    main()

requirements.txt

@@ -0,0 +1 @@
+GitPython

setup.py

@@ -0,0 +1,20 @@
+from setuptools import setup
+
+setup(
+    name='gh_fork_sync',
+    version='0.1',
+    py_modules=['gh_fork_sync'],
+    install_requires=['GitPython'],
+    entry_points={
+        'console_scripts': [
+            'gh-fork-sync=gh_fork_sync:main',
+        ],
+    },
+    author='Shripad Bankar',
+    description='Sync GitHub fork with upstream repo via CLI',
+    license='MIT',
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License'
+    ],
+)