Commit 5b23fa6
committed
Fill out readme more
1 parent 3baf25f commit 5b23fa6
1 file changed
Lines changed: 60 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3,3 +3,63 @@ github-backup | |||
| 3 | 3 | ============= | |
| 4 | 4 | ||
| 5 | 5 | backup a github user or organization | |
| 6 | + | ||
| 7 | + Installation | ||
| 8 | + ============ | ||
| 9 | + | ||
| 10 | + Using PIP via PyPI:: | ||
| 11 | + | ||
| 12 | + pip install github-backup | ||
| 13 | + | ||
| 14 | + Using PIP via Github:: | ||
| 15 | + | ||
| 16 | + pip install git+git://github.com/josegonzalez/python-github-backup.git#egg=github-backup | ||
| 17 | + | ||
| 18 | + Usage | ||
| 19 | + ===== | ||
| 20 | + | ||
| 21 | + CLI Usage is as follows:: | ||
| 22 | + | ||
| 23 | + Github Backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN] | ||
| 24 | + [-o OUTPUT_DIRECTORY] [--starred] [--watched] [--all] | ||
| 25 | + [--issues] [--issue-comments] [--issue-events] | ||
| 26 | + [--repositories] [--wikis] [--skip-existing] | ||
| 27 | + [-L [LANGUAGES [LANGUAGES ...]]] [-N NAME_REGEX] | ||
| 28 | + [-R REPOSITORY] [-P] [-F] [-v] | ||
| 29 | + USER | ||
| 30 | + | ||
| 31 | + Backup a github users account | ||
| 32 | + | ||
| 33 | + positional arguments: | ||
| 34 | + USER github username | ||
| 35 | + | ||
| 36 | + optional arguments: | ||
| 37 | + -h, --help show this help message and exit | ||
| 38 | + -u USERNAME, --username USERNAME | ||
| 39 | + username for basic auth | ||
| 40 | + -p PASSWORD, --password PASSWORD | ||
| 41 | + password for basic auth | ||
| 42 | + -t TOKEN, --token TOKEN | ||
| 43 | + personal access or OAuth token | ||
| 44 | + -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY | ||
| 45 | + directory at which to backup the repositories | ||
| 46 | + --starred include starred repositories in backup | ||
| 47 | + --watched include watched repositories in backup | ||
| 48 | + --all include everything in backup | ||
| 49 | + --issues include issues in backup | ||
| 50 | + --issue-comments include issue comments in backup | ||
| 51 | + --issue-events include issue events in backup | ||
| 52 | + --repositories include repository clone in backup | ||
| 53 | + --wikis include wiki clone in backup | ||
| 54 | + --skip-existing skip project if a backup directory exists | ||
| 55 | + -L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]] | ||
| 56 | + only allow these languages | ||
| 57 | + -N NAME_REGEX, --name-regex NAME_REGEX | ||
| 58 | + python regex to match names against | ||
| 59 | + -R REPOSITORY, --repository REPOSITORY | ||
| 60 | + name of repository to limit backup to | ||
| 61 | + -P, --private include private repositories | ||
| 62 | + -F, --fork include forked repositories | ||
| 63 | + -v, --version show program's version number and exit | ||
| 64 | + | ||
| 65 | + 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). | ||
0 commit comments