find_forks

Finds all forks of user/repo on github and add it as git remote to your local cloned repo. Useful to find interesting commits of:

• old repo with many updated forks,
• fresh repo with many forks that original author doesn't want or doesn't have time to merge.

Try it out now, just type:

user@host ~/git $ git clone https://github.com/frost-nzcr4/find_forks.git
Cloning into 'find_forks'...
user@host ~/git $ git clone https://github.com/frost-nzcr4/webmoney.git
Cloning into 'webmoney'...
user@host ~/git $ cd webmoney/
user@host ~/git/webmoney $ python ../find_forks/
git config --get remote.origin.url
Open https://api.github.com/repos/frost-nzcr4/webmoney/forks?per_page=100
git remote add github-user-1 https://github.com/github-user-1/webmoney.git
git remote add github-user-2 https://github.com/github-user-2/webmoney.git
git fetch --all
Possible interesting forks
                                 | forks | stargazers | watchers
----------------------------------------------------------------
                   github-user-2 |    0 |    1 |    1
user@host ~/git/webmoney $ ./../find_forks/remove_duplicate_branches.sh your-github-name
Deleted remote branch github-user-1/master (was 5827568).
Deleted remote branch github-user-2/master (was 5827568).
Deleted remote branch github-user-1/develop (was cd7ec22).
Deleted remote branch github-user-2/develop (was cd7ec22).

Install

You need python (3.4.2 and 2.7.8 tested) and pip installed.

git clone --branch master https://github.com/frost-nzcr4/find_forks.git
cd find_forks
pip install -r requirements-prod.txt

Usage

Basics

1. Run as console comand:

   At first you need some cloned project and cd to one's root:

   git clone https://github.com/some_user/some_project.git
   cd some_project

   Now you can run find_forks one of the following methods:

   • specify path to folder:

     python /path/to/find_forks

   • specify module name If find_forks in your PYTHONPATH:

     python -m find_forks

   • or if you obtained zip from github you could simply run it:

     python /path/to/find_forks.zip

   You can provide arguments to get forks of specified user/repo:

   python /path/to/find_forks --user=user --repo=repo

2. Use as module:

   from find_forks.find_forks import find_forks
   
   find_forks()

3. Now remove duplicate branches. Current workaround to remove duplicates is remove_duplicate_branches.sh:

   /path/to/find_forks/remove_duplicate_branches.sh your-github-name

How to fetch large repo

When repo has over 6000 forks one may face a github's API limit. To continue fetching use start-page option:

python /path/to/find_forks --user=user --repo=repo --start-page 61

Define your own name determination handler

from find_forks.find_forks import determine_names, find_forks


def my_handler():
    """Your own handler."""
    # Do something.
    
    # If something goes wrong you can run default handler, just uncomment following line.
    #return determine_names()

    # This is mandatory. Your handler should return user and repo names.
    return user, repo

find_forks(determine_names_handler=my_handler):

How to contribute

Install additional development requirements:

pip install -r requirements-dev.txt

Before you start to pull request your changes on github please run tests to make sure that nothing went wrong:

./tests/run.py

and check that result doesn't break python code conventions:

pep8
pylint __main__.py find_forks
pylint -d C0111 tests

Check coverage if you needed it:

coverage run tests/run.py
coverage html

then open tests/coverage/html_report/index.html with your browser.

License & Authors

When I needed find_forks functionality I'd start to search for available projects and found gist of Anand Kumria (@akumria) which I used as starting point to this module.

Copyright (c) 2015 Alexander Pervakov

See the file "LICENSE" for information on terms & conditions for usage.