Skip to main content

backup a github user or organization

Project description

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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github-backup-0.3.0.tar.gz (6.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page