Metadata-Version: 2.1
Name: gita
Version: 0.7.7
Summary: Manage multiple git repos
Home-page: https://github.com/nosarthur/gita
Author: Dong Zhou
Author-email: zhou.dong@gmail.com
License: MIT
Description: [![PyPi version](https://img.shields.io/pypi/v/gita.svg)](https://pypi.org/project/gita/)
        [![Build Status](https://travis-ci.org/nosarthur/gita.svg?branch=master)](https://travis-ci.org/nosarthur/gita)
        [![codecov](https://codecov.io/gh/nosarthur/gita/branch/master/graph/badge.svg)](https://codecov.io/gh/nosarthur/gita)
        [![licence](https://img.shields.io/pypi/l/gita.svg?style=flat)](https://github.com/nosarthur/gita/blob/master/LICENSE)
        
        # Gita: a command-line tool to manage multiple git repos
        
        This tool does two things
        
        - display the status of multiple git repos such as branch, modification, commit message side by side
        - delegate git commands/aliases from any working directory
        
        If several repos need to be compiled against each other, it helps to see their
        status together. I also hate to change directories to execute git commands.
        
        ![gita screenshot](https://github.com/nosarthur/gita/raw/master/screenshot.png)
        
        Here the colors denote the 5 situations between local and remote branches:
        
        - white: local branch has no remote branch
        - green: local branch is the same as remote branch
        - red: local branch has diverged from remote branch
        - purple: local branch is ahead of remote branch (good for push)
        - yellow: local branch is behind remote branch (good for merge)
        
        The choice of purple for ahead and yellow for behind is motivated by
        [blueshift](https://en.wikipedia.org/wiki/Blueshift) and [redshift](https://en.wikipedia.org/wiki/Redshift),
        using green as baseline.
        
        The additional status symbols denote
        
        - `+`: staged changes
        - `*`: unstaged changes
        - `_`: untracked files/folders
        
        The bookkeeping sub-commands are
        
        - `gita add <repo-path(s)>`: add repo(s) to `gita`
        - `gita rm <repo-name>`: remove repo from `gita` (won't remove repo from disk)
        - `gita ls`: display the status of all repos
        - `gita ls <repo-name>`: display the absolute path of one repo
        - `gita -v`: display gita version
        
        Repo paths are saved in `$XDG_CONFIG_HOME/gita/repo_path` (most likely `~/.config/gita/repo_path`).
        
        The delegated git sub-commands are of two forms
        
        - `gita <sub-command> <repo-name(s)>` with required repo name(s) input
        - `gita <sub-command> [repo-name(s)]` with optional input. And no input means
          all repos.
        
        By default, only `fetch` and `pull` take optional input.
        Sub-commands with required input include `branch`, `clean`, `diff`, `difftool`,
        `log`, `merge`, `patch`, `push`, `rebase`, `reflog`, `remote`,
        `stash`, `stat`, and `status`.
        
        Delegation details are specified in
        [cmds.yml](https://github.com/nosarthur/gita/blob/master/gita/cmds.yml).
        For example, `gita stat <repo-name(s)>` is registered as
        
        ```yaml
        stat:
          cmd: diff --stat
          help: show edit statistics
        ```
        
        which executes `git diff --stat`.
        
        If the delegated git command is a single word, the `cmd` tag can be omitted.
        For example, `gita push <repo-name(s)>` is registered as
        
        ```yaml
        push:
          help: push the local updates
        ```
        
        ## Customization
        
        Custom git commands/aliases can be placed in `$XDG_CONFIG_HOME/gita/cmds.yml`
        (most likely `~/.config/gita/cmds.yml`).
        And they shadow the default ones in the case of name clashes.
        
        If you want a custom command to behave like `gita fetch`, i.e., to apply
        command to all repos if nothing is specified,
        set the `allow_all` option to be `true`.
        For example, the following snippet creates a new command
        `gita comaster [repo-name(s)]` with optional repo name input.
        
        ```yaml
        comaster:
          cmd: checkout master
          allow_all: true
          help: checkout the master branch
        ```
        
        ## Superman mode
        
        The superman mode delegates any git command/alias for specified or all repo(s).
        Usage:
        
        ```
        gita super [repo-name(s)] <command/alias>
        ```
        
        Here `repo-name(s)` is optional, and absence means all repos.
        For example,
        
        - `gita super myrepo1 commit -am 'fix a bug'`
          executes `git commit -am 'fix a bug'` for `myrepo1`
        - `gita super checkout master` puts all repos on the master branch (also see the customization example)
        - `gita super frontend_repo backend_repo checkout new-feature` puts the two
          chosen repos on the `new-feature` branch
        
        ## Requirements
        
        Gita requires Python 3.6 or higher, due to the use of
        [f-string](https://www.python.org/dev/peps/pep-0498/)
        and [asyncio module](https://docs.python.org/3.6/library/asyncio.html).
        
        ## Installation
        
        To install the latest version, run
        
        ```
        pip3 install -U gita
        ```
        
        If development mode is preferred,
        download the source code and run `pip3 install -e <gita-source-folder>`.
        In either case, calling `gita` in terminal may not work,
        then you can put the following line in the `.bashrc` file.
        
        ```
        alias gita="python3 -m gita"
        ```
        
        ## Auto-completion
        
        For auto completion, download
        [.gita-completion.bash](https://github.com/nosarthur/gita/blob/master/.gita-completion.bash)
        and source it in `.bashrc`.
        
        ## Contributing
        
        To contribute, you can
        
        - report/fix bugs
        - request/implement features
        - star/recommend this project
        
        To run tests locally, simply `pytest`.
        
        ## Other multi-repo tools
        
        I haven't tried them but I heard good things about them.
        
        - [myrepos](https://myrepos.branchable.com/)
        - [repo](https://source.android.com/setup/develop/repo)
        
Keywords: git,manage multiple repositories
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
