Giter Club home page Giter Club logo

python-github-backup's Introduction

github-backup

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.