Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Manages multiple git repositories

Project description

# GitManager

[![Build Status](https://travis-ci.org/tkw1536/GitManager.svg?branch=master)](https://travis-ci.org/tkw1536/GitManager)
[![PyPI version](https://badge.fury.io/py/git_manager.svg)](https://pypi.python.org/pypi/git_manager)

A script that can handle multiple Git repositories locally.
Written in Python, supports version 3.5 and upwards.

## Installation

Make sure python is installed, then run

```bash
python setup.py install
```

or

```bash
pip install git_manager
```


to install the package. This will make it available by running ```git-manager``` (or ```git manager```).

## Usage

Git-Manager has different commands it provides:

1. ```git-manager setup [pattern]``` -- Sets up all repositories as configured in the
Configuration file.
2. ```git-manager clone``` -- Clones a repository to a location determined by
the repository url and the root directory. For example:
`git manager clone --save https://github.com/tkw1536/GitManager`
3. ```git-manager fetch [pattern]``` -- Updates all local repositories by fetching all
data from the remotes.
4. ```git-manager pull [pattern]``` -- Updates all local repositories by pulling all
repositories.
5. ```git-manager push [pattern]``` -- Pushes all repositories to the remote.
6. ```git-manager ls [pattern]``` -- Lists all locally available repositories.
7. ```git-manager status [pattern]``` -- Shows all repositories that do not have a
clean working tree, i.e. those where ```git status``` shows a message.
8. ```git-manager state [pattern]``` -- Shows all repositories for which the local
branch is not equal to the remote branch.
9. ```git-manager reconfigure``` -- Updates configuration file with
repositories found in a specific folder
10. ```git-manager gc [pattern]``` -- Runs houskeeping tasks on all local repositories

Some commands optionally accept the `pattern` argument.
This can be used to filter repository by their name.

Repository patterns are simple `glob-like` pattern matches on standardized remote URLs.
They can also be normal glob patterns on full URLs.

For example:

| Pattern | Examples |
| ----------------- | -------------------------------------------------------------------- |
| `world` | `git@github.com:hello/world.git`, `https://github.com/hello/world` |
| `hello/*` | `git@github.com:hello/earth.git`, `git@github.com:hello/mars.git` |
| `hello/m*` | `git@github.com:hello/mars.git`, `git@github.com:hello/mercury.git` |
| `github.com/*/*` | `git@github.com:hello/world.git`, `git@github.com:bye/world.git` |
| `github.com/hello`| `git@github.com:hello/world.git`, `git@github.com:hello/mars.git` |

## Configuration

Git Manager can be configured through its configuration file.
In order, it looks for the configuration file in the following locations:

1. ```$GIT_MANAGER_CONFIG``` (if set)
2. ```~/.config/.gitmanager/config``` (or ```$XDG_CONFIG_HOME/.gitmanager/config``` if set)
3. ```~/.gitmanager```

The configuration file is parsed line-by-line and declares which repositories are under
GitManager control. It consists of three different types of directives:

1. **Root Line**
Configure the root folder to clone repositories to automatically.
Starts with two hashes, then sets the folder relative to the users home direectory. For example:
```
## /opt/repositories
```
2. **Comments**
Anything starting with a "#" will be treated as a comment. The same goes for empty (or whitespace-only)
lines.
3. **Repository instruction**
To declare a repository write ```REPOSITORY_URL \[FOLDER\]```. This declares that the repository
from ```REPOSITORY_URL``` should be cloned into the folder ```FOLDER```. In case the folder is omitted,
the 'humanish' part of the URI will be taken automatically. All folder paths by default are relative to
the users home folder, but this can be changed with the instruction below. Example:
```
# makes the git/git repository available locally in the folder ~/Projects/git
https://github.com/git/git Projects/git

# makes the GitManager repository available in the ~/GitManager repository
https://github.com/tkw1536/GitManager
```
4. **Group Instruction**
In the case where multiple repositories should be cloned into the same folder, it is inconvenient to
always give the full path to that folder in the configuration file. For this reason GitManager supports
the concept of a group. A group can be started by prefixing a line with the ">" character. A group takes
one argument. A path to a folder all repositories should be cloned into. This is best illustrated in the
form of an example:
```
# We can create a group to store all our atom-related projects.
# All repositories are automatically available in the ~/AtomProjects folder.
> AtomProjects
https://github.com/atom/atom
https://github.com/atom/markdown-preview
# ...

```
Groups completely support nesting. A sub-groups path and pattern for origin are relative to
the parent group. To create a sub-group, add another ">" character in front of the line.


An example configuration file can be found in the file [config_example](config_example).

## Development and Testing

This project is unit tested with a high coverage rate.
The tests can be run with:

```bash
nosetests --with-coverage --cover-package GitManager
```

Tests are automatically run on Travis CI after every commit.

## License

```
The MIT License (MIT)

Copyright (c) 2016-17 Tom Wiesing

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for git_manager, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size git_manager-0.1.0.tar.gz (19.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page