Metadata-Version: 2.1
Name: forks-sync
Version: 2.0.0
Summary: Keep all your forks up to date with the remote master branch.
Home-page: http://github.com/justintime50/forks
Author: Justintime50
License: MIT
Description: <div align="center">
        
        # Forks
        
        Keep all your forks up to date with the remote master branch.
        
        [![Build Status](https://travis-ci.com/Justintime50/forks.svg?branch=master)](https://travis-ci.com/Justintime50/forks)
        [![Coverage Status](https://coveralls.io/repos/github/Justintime50/forks/badge.svg?branch=master)](https://coveralls.io/github/Justintime50/forks?branch=master)
        [![PyPi](https://img.shields.io/pypi/v/forks-sync)](https://pypi.org/project/forks-sync)
        [![Licence](https://img.shields.io/github/license/justintime50/forks)](LICENSE)
        
        <img src="assets/showcase.png">
        
        </div>
        
        If you manage more than a couple git forks, keeping them up to date with the remote master can be a pain. Forks lets you avoid all the fuss by concurrently cloning each of your projects locally, adding the remote upstream, fetching upstream changes, rebasing them, and force pushing to your origin repo master branch - keeping all your forks up to date with the original repo.
        
        By default, Forks will save all your forks to `~/forks-sync` where you can also find logs for this tool.
        
        ## Install
        
        ```bash
        # Install tool
        pip3 install forks-sync
        
        # Install locally
        make install
        
        # Get Makefile help
        make help
        ```
        
        ## Usage
        
        ```bash
        # Setup your ssh agent to ensure the script runs continually
        ssh-add
        
        # Pass your GitHub API key/token here:
        GITHUB_TOKEN=123... forks-sync
        
        # Optional params:
        # FORKS_SYNC_LOCATION="~/my-folder"
        ```
        
        ## Development
        
        ```bash
        # Lint the project
        make lint
        
        # Run tests
        make test
        
        # Run test coverage
        make coverage
        
        # Run the tool locally
        venv/bin/python forks/sync.py --help
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
