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] [--labels] [--hooks] [--skip-existing]
                 [-L [LANGUAGES [LANGUAGES ...]]] [-N NAME_REGEX]
                 [-H GITHUB_HOST] [-O] [-R REPOSITORY] [-P] [-F]
                 [--prefer-ssh] [-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
  --labels              include labels in backup
  --hooks               include web hooks in backup (works only when authenticated)
  --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
  --prefer-ssh          Clone repositories using SSH instead of HTTPS
  -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.6.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

github_backup-0.6.0-py2-none-any.whl (11.6 kB view details)

Uploaded Python 2

File details

Details for the file github-backup-0.6.0.tar.gz.

File metadata

File hashes

Hashes for github-backup-0.6.0.tar.gz
Algorithm Hash digest
SHA256 a92e1942ed8e457991a5edf65e7fa26fddd54eb960211744811dbadf5c41e860
MD5 71f1c977d10e5ed6bca3e797e7cdc215
BLAKE2b-256 3ea959883195b7b923561cdf375801e2e2d2b1f2d094cf584194cf4cf4efe75f

See more details on using hashes here.

File details

Details for the file github_backup-0.6.0-py2-none-any.whl.

File metadata

File hashes

Hashes for github_backup-0.6.0-py2-none-any.whl
Algorithm Hash digest
SHA256 6068ef3bad9b7976d803ffc6ee836cb4b9ba2ad57c4632af20e7184a23dbdfcc
MD5 8c98fdc69e5b3b349728807c5a5a49f6
BLAKE2b-256 6fc86eab59fcbbcbcf8bf92fa8ad692e79c36dd34e3871b43d2c872b24461036

See more details on using hashes here.

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