python-github-backup

mirror of https://github.com/josegonzalez/python-github-backup.git synced 2025-12-05 08:08:02 +01:00

Go to file

Kevin Laude e8387f9a7f Add pull request support

Back up reporitory pull requests by passing the --include-pulls
argument. Pull requests are saved to
repositories/<repository name>/pulls/<pull request number>.json. Include
the --pull-request-comments argument to add review comments to the pull
request backup and pass the --pull-request-commits argument to add
commits to the pull request backup.

Pull requests are automatically backed up when the --all argument is
uesd.

2015-01-16 09:57:05 -06:00

bin

Add pull request support

2015-01-16 09:57:05 -06:00

github_backup

Release 0.2.0

2014-09-22 01:30:38 -04:00

.gitignore

Create .gitignore

2014-09-03 11:47:20 -04:00

LICENSE.txt

Create LICENSE.txt

2014-09-03 11:40:08 -04:00

MANIFEST.in

Create MANIFEST.in

2014-09-03 11:47:54 -04:00

README.rst

Add pull request support

2015-01-16 09:57:05 -06:00

requirements.txt

Create requirements.txt

2014-09-03 11:45:14 -04:00

setup.py

Fix import

2014-09-08 12:31:57 -04:00

README.rst

=============
github-backup
=============

backup a github user or organization

Installation
============

Using PIP via PyPI::

    pip install github-backup

Using PIP via Github::

    pip install git+git://github.com/josegonzalez/python-github-backup.git#egg=github-backup

Usage
=====

CLI Usage is as follows::

    Github Backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN]
                     [-o OUTPUT_DIRECTORY] [--starred] [--watched] [--all]
                     [--issues] [--issue-comments] [--issue-events] [--pulls]
                     [--pull-comments] [--pull-commits] [--repositories]
                     [--wikis] [--skip-existing]
                     [-L [LANGUAGES [LANGUAGES ...]]] [-N NAME_REGEX]
                     [-H GITHUB_HOST] [-O] [-R REPOSITORY] [-P] [-F] [-v]
                     USER

    Backup a github users account

    positional arguments:
      USER                  github username

    optional arguments:
      -h, --help            show this help message and exit
      -u USERNAME, --username USERNAME
                            username for basic auth
      -p PASSWORD, --password PASSWORD
                            password for basic auth
      -t TOKEN, --token TOKEN
                            personal access or OAuth token
      -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
                            directory at which to backup the repositories
      --starred             include starred repositories in backup
      --watched             include watched repositories in backup
      --all                 include everything in backup
      --issues              include issues in backup
      --issue-comments      include issue comments in backup
      --issue-events        include issue events in backup
      --pulls               include pull requests in backup
      --pull-comments       include pull request review comments in backup
      --pull-commits        include pull request commits in backup
      --repositories        include repository clone in backup
      --wikis               include wiki clone in backup
      --skip-existing       skip project if a backup directory exists
      -L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]]
                            only allow these languages
      -N NAME_REGEX, --name-regex NAME_REGEX
                            python regex to match names against
      -H GITHUB_HOST, --github-host GITHUB_HOST
                            GitHub Enterprise hostname
      -O, --organization    whether or not this is a query for an organization
      -R REPOSITORY, --repository REPOSITORY
                            name of repository to limit backup to
      -P, --private         include private repositories
      -F, --fork            include forked repositories
      -v, --version         show program's version number and exit

The package can be used to backup an *entire* organization or repository, including issues and wikis in the most appropriate format (clones for wikis, json files for issues).