Metadata-Version: 2.1
Name: ghbak
Version: 0.1.5
Summary: github backup
Home-page: https://github.com/obfusk/ghbak
Author: Felix C. Stegerman
Author-email: flx@obfusk.net
License: GPLv3+
Description: <!-- {{{1 -->
        
            File        : README.md
            Maintainer  : Felix C. Stegerman <flx@obfusk.net>
            Date        : 2020-06-22
        
            Copyright   : Copyright (C) 2020  Felix C. Stegerman
            Version     : v0.1.5
            License     : GPLv3+
        
        <!-- }}}1 -->
        
        [![PyPI Version](https://img.shields.io/pypi/v/ghbak.svg)](https://pypi.python.org/pypi/ghbak)
        [![CI](https://github.com/obfusk/ghbak/workflows/CI/badge.svg)](https://github.com/obfusk/ghbak/actions?query=workflow%3ACI)
        [![GPLv3+](https://img.shields.io/badge/license-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
        
        ## Description
        
        ghbak - github backup
        
        Mirror (or update) github repos (and issues) and/or gists to:
        
        ```
        {basedir}/
          {github_username}/
            github/
              {repo_name}.git
              {repo_name}-issues.json
              ...
            gist/
              {gist_id}.git
              ...
        ```
        
        The base directory defaults to `./{YYYYMMDD}` (the current date).
        
        ## Examples
        
        ```bash
        $ export GITHUB_TOKEN=your-github-token
        $ ghbak --repos --gists --ssh --verbose your-github-username
        user: your-github-username
        token $GITHUB_TOKEN
        GET https://api.github.com/users/your-github-username/repos
        ...
        GET https://api.github.com/users/your-github-username/gists
        ...
        cloning 42 repos...
        ==> repo your-github-username/your-repo | description
        $ cd 20200101/your-github-username/github
        $ git clone --mirror -n git@github.com:your-github-username/your-repo.git your-repo.git
        ...
        cloning 37 gists...
        ==> gist your-github-username | gist-id | description
        $ cd 20200101/your-github-username/gist
        $ git clone --mirror -n git@gist.github.com:gist-id.git gist-id.git
        ...
        
        === summary ===
        
        backed up repos: 42
        backed up gists: 37
        ```
        
        ## Help
        
        ```bash
        $ ghbak --help
        ```
        
        ## Requirements
        
        Python >= 3.5 + click + requests.
        
        ## Installing
        
        ### Using pip
        
        ```bash
        $ pip install ghbak
        ```
        
        ### Manually
        
        Install the dependencies (as e.g. debian packages or using `pip`):
        
        ```bash
        $ apt install python3-click python3-requests  # debian/ubuntu
        $ pip install click requests                  # pip
        ```
        
        Then just put `ghbak` somewhere on your `$PATH` (e.g. `~/bin`).
        
        ## License
        
        [![GPLv3+](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.html)
        
        <!-- vim: set tw=70 sw=2 sts=2 et fdm=marker : -->
        
Keywords: git github gist backup
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: Utilities
Requires-Python: >=3.5
Description-Content-Type: text/markdown
