updated README
This commit is contained in:
parent
45aa7163b0
commit
df62f1b922
1 changed files with 30 additions and 10 deletions
|
@ -1,17 +1,13 @@
|
||||||
GitHub-Backup
|
GitHub-Backup
|
||||||
=============
|
============================
|
||||||
|
|
||||||
Idea/original implementation by Chris Lockfort (clockfort@csh.rit.edu) (Github username: Clockfort)
|
|
||||||
|
|
||||||
Python version by Anthony Gargiulo (anthony@agargiulo.com) (Github username: agargiulo)
|
|
||||||
|
|
||||||
Description
|
Description
|
||||||
----
|
----------------------------
|
||||||
|
|
||||||
GitHub-Backup makes a local backup copy of all of a github user's (or github organization's) repositories.
|
GitHub-Backup makes a local backup copy of all of a github user's (or github organization's) repositories.
|
||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
----
|
----------------------------
|
||||||
|
|
||||||
GitHub-Backup requires `pygithub3` a Python library for the GitHub API v3.
|
GitHub-Backup requires `pygithub3` a Python library for the GitHub API v3.
|
||||||
|
|
||||||
|
@ -20,9 +16,10 @@ Installation is simple with
|
||||||
pip install pygithub3
|
pip install pygithub3
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
----------------------------
|
||||||
````
|
````
|
||||||
usage: github-backup.py [-h] [-c] [-m] [-g ARGS] [-s SUFFIX]
|
usage: github-backup.py [-h] [-c] [-m] [-S] [-g ARGS] [-s SUFFIX] [-P PREFIX]
|
||||||
|
[-p PASSWORD] [-t TOKEN] [-o ORG]
|
||||||
username backupdir
|
username backupdir
|
||||||
|
|
||||||
makes a backup of all of a github user's repositories
|
makes a backup of all of a github user's repositories
|
||||||
|
@ -35,9 +32,18 @@ optional arguments:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
-c, --cron Use this when running from a cron job
|
-c, --cron Use this when running from a cron job
|
||||||
-m, --mirror Create a bare mirror
|
-m, --mirror Create a bare mirror
|
||||||
|
-S, --ssh Use SSH protocol
|
||||||
-g ARGS, --git ARGS Pass extra arguments to git
|
-g ARGS, --git ARGS Pass extra arguments to git
|
||||||
-s SUFFIX, --suffix SUFFIX
|
-s SUFFIX, --suffix SUFFIX
|
||||||
Add suffix to repository directory names
|
Add suffix to repository directory names
|
||||||
|
-P PREFIX, --prefix PREFIX
|
||||||
|
Add prefix to repository directory names
|
||||||
|
-p PASSWORD, --password PASSWORD
|
||||||
|
Authenticate with Github API
|
||||||
|
-t TOKEN, --token TOKEN
|
||||||
|
OAuth token for authentification
|
||||||
|
-o ORG, --organization ORG
|
||||||
|
Backup Organizational repositories
|
||||||
````
|
````
|
||||||
|
|
||||||
Then, put it in a cron job somewhere and forget about it for eternity.
|
Then, put it in a cron job somewhere and forget about it for eternity.
|
||||||
|
@ -61,3 +67,17 @@ Questions, Improvements, Etc
|
||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
||||||
If you have any improvements, I'm happy, (grateful, in fact) to entertain pull requests/patches, just drop me a line or message me on GitHub.
|
If you have any improvements, I'm happy, (grateful, in fact) to entertain pull requests/patches, just drop me a line or message me on GitHub.
|
||||||
|
|
||||||
|
Contributors
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
Idea/original implementation by
|
||||||
|
|
||||||
|
- Chris Lockfort (clockfort@csh.rit.edu) (Github: Clockfort)
|
||||||
|
(Original idea)
|
||||||
|
|
||||||
|
- Anthony Gargiulo (anthony@agargiulo.com) (Github: agargiulo)
|
||||||
|
(Python version)
|
||||||
|
|
||||||
|
- Steffen Vogel (post@steffenvogel.de) (Github: stv0g)
|
||||||
|
(A lot of patches and improvements)
|
||||||
|
|
Loading…
Add table
Reference in a new issue