backup a github user or organization
Project description
backup a github user or organization
Requirements
GIT 1.9+
Installation
Using PIP via PyPI:
pip install github-backup
Using PIP via Github:
pip install git+https://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] [-i] [--starred] [--watched]
[--all] [--issues] [--issue-comments] [--issue-events]
[--pulls] [--pull-comments] [--pull-commits] [--labels]
[--hooks] [--milestones] [--repositories] [--wikis]
[--skip-existing] [-L [LANGUAGES [LANGUAGES ...]]]
[-N NAME_REGEX] [-H GITHUB_HOST] [-O] [-R REPOSITORY]
[-P] [-F] [--prefer-ssh] [-v]
USER
Backup a github 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. If a username is given but
not a password, the password will be prompted for.
-t TOKEN, --token TOKEN
personal access or OAuth token
-o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
directory at which to backup the repositories
-i, --incremental incremental backup
--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
--labels include labels in backup
--hooks include hooks in backup (works only when
authenticated)
--milestones include milestones 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 an organization user
-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).
Authentication
Note: Password-based authentication will fail if you have two-factor authentication enabled.
Release history Release notifications | RSS feed
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.11.0.tar.gz
(12.3 kB
view details)
Built Distribution
File details
Details for the file github-backup-0.11.0.tar.gz.
File metadata
- Download URL: github-backup-0.11.0.tar.gz
- Upload date:
- Size: 12.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7cc3683ed1783abce2912b3abec24bcd2e84d05c99ff027db6ee8452159ab18d |
|
| MD5 | b84373cfe4d26964b33d44e53c099b8d |
|
| BLAKE2b-256 | 3cf1fea32654bf48dfe7e199b4257a1baac518a348b696b2fc9dbbb65ddcfd6e |
File details
Details for the file github_backup-0.11.0-py2-none-any.whl.
File metadata
- Download URL: github_backup-0.11.0-py2-none-any.whl
- Upload date:
- Size: 12.7 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4499ab036b3fe4fc399a77d252c8008202a2efd3beaefa4a0a9c87868f369892 |
|
| MD5 | 54941ea6168af70d193259c0865d437c |
|
| BLAKE2b-256 | 7b1e04c1e86b8628af4611f02674adc1313dbc3f8dc363efa4473b99681ea53d |
