README.md

github-backup-tool

BIG NOTE: This is a work-in-progress.

A crunchy tool for backing up repositories of multiple specified GitHub organizations.

What does it do?

It will backup all Git repositories it has access to.

What does it not do?

At this moment, it will not back up:

• Issues
• Comments
• Hooks
• ...

Eventually, backing up of these will be implemented.

How to use?

1. Set up a GitHub token, with a "repo" scope.
2. Configure the config.yaml file accordingly.
3. Set up your running environment either via a virtualenv or distribution packages:
   • virtualenv:
     • Create a Python virtual environment via virtualenv venv
     • Activate your venv via source venv/bin/activate (Consider the shell you are using, and adjuct this step accrodingly.)
     • Install via pip install github-backup-tool
   • distribution packages:
     • GitPython, GitPython@Repology
     • PyGithub, PyGithub@Repology
     • PyYAML, PyYAML@Repology
4. Run gbt -c yourconfig.yaml.

TODOs:

• Backup abandoned commits in master as a separate branch if commits were pushed to origin forcefully
• Backup issues
• Backup hooks
• Backup information of users, belonging to an organization
• Configuration: allow for ignoring of certain repositories
• Brainstorm about more ideas as to what to back up