Metadata-Version: 2.1
Name: git_mirror
Version: 0.3.1
Summary: Make your local git repos look like github or gitlab. See readme for how this differs from the many other multi-repo tools.
Home-page: https://github.com/matthewdeanmartin/git_mirror
License: MIT
Keywords: git,gitlab,github,polyrepo
Author: Matthew Martin
Author-email: matthewdeanmartin@gmail.com
Requires-Python: >=3.9
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: GitPython (>=3.1.42)
Requires-Dist: PyGithub (>=2.2.0)
Requires-Dist: colorama (>=0.4.6,<1)
Requires-Dist: colorlog (>=6.8.0,<7)
Requires-Dist: httpx (>=0.26.0,<1)
Requires-Dist: inquirer (>=3.2.3,<4)
Requires-Dist: prettytable (==3.9.0)
Requires-Dist: python-dotenv (>=1.0.1,<2)
Requires-Dist: python-gitlab (>=4.4.0)
Requires-Dist: rich (>=13.7.0,<14)
Requires-Dist: termcolor (>=2.4.0,<3)
Requires-Dist: toml (>=0.10.2,<1)
Requires-Dist: tomlkit (>=0.12.3,<1)
Project-URL: Bug Tracker, https://github.com/matthewdeanmartin/git_mirror/issues
Project-URL: Change Log, https://github.com/matthewdeanmartin/git_mirror/blob/main/CHANGELOG.md
Project-URL: Documentation, https://matthewdeanmartin.github.io/git_mirror/git_mirror/index.html
Project-URL: Repository, https://github.com/matthewdeanmartin/git_mirror
Description-Content-Type: text/markdown

# git_mirror

Make your local git repos look like Github or Gitlab.

Supports

- clone all
- pull all
- prune unnecessary branches (PENDING)
- update branch from main (PENDING)
- checking for unpushed changes.

Does not support running arbitrary scripts in each repo.

Goal is for tools to be built-in, to be easy.

Also supports parallel execution.  (PENDING)

## Installation

```bash
pipx install git-mirror
# Interactively initialize configuration
git_mirror init
# Interactively select command for Github
gh_mirror menu
```

Requires .env file with Github or Gitlab token.

```bash
GITHUB_ACCESS_TOKEN=PAT
GITLAB_ACCESS_TOKEN=PAT
SELFHOSTED_ACCESS_TOKEN=PAT
```

## Usage

CLI tool. Run in the directory with your pyproject.toml file.

You have forgotten to clone some repos on your secondary laptop. Run `git_mirror clone-all`.

You probably made changes and forgot to pull them. Run `git_mirror pull-all`.

You have made changes to many repos and can't remember which. Run `git_mirror local-changes`.

You have pushed changes to many repos and forgot if you deployed them to pypi or not. Run `git_mirror build-status`.

Github doesn't summarize failing builds across all repos. Run `git_mirror build-status`.

Your local folder has a bunch of stray folders that aren't even repos. Run `git_mirror not-repo`.

You care about some repos more than others, use config to focus on a subset of repos. (PENDING FEATURE)

```text
usage: git_mirror [-h] [-V] [--menu MENU] [--host {gitlab,github}] [--user-name USER_NAME] [--group-id GROUP_ID]
                  [--domain DOMAIN] [--pypi-owner-name PYPI_OWNER_NAME] [--target-dir TARGET_DIR] [--include-forks]
                  [--include-private] [--config-path CONFIG_PATH] [--verbose]
                  {menu,init,show-account,list-repos,clone-all,pull-all,local-changes,not-repo,build-status,sync-config,list-config,pypi-status}

Make your local git repos look like github or gitlab. See readme for how this differs from the many other multi-repo tools.

positional arguments:
  {menu,init,show-account,list-repos,clone-all,pull-all,local-changes,not-repo,build-status,sync-config,list-config,pypi-status}
                        The command to execute.

options:
  -h, --help            show this help message and exit
  -V, --version         Show program's version number and exit.
  --menu MENU           Choose a command via menu.
  --host {gitlab,github}
                        Source host, use gl_mirror or gh_mirror to skip this.
  --user-name USER_NAME
                        The username.
  --group-id GROUP_ID   The gitlab group id.
  --domain DOMAIN       The gitlab (compatible) domain.
  --pypi-owner-name PYPI_OWNER_NAME
                        Pypi Owner Name.
  --target-dir TARGET_DIR
                        The directory where repositories will be cloned or pulled.
  --include-forks       Include forked repositories.
  --include-private     Include private repositories.
  --config-path CONFIG_PATH
                        Path to the TOML config file.
  --verbose             verbose output

    Examples:

        # Interactively initialize configuration
        git_mirror init

        # Interactively select command
        git_mirror menu
```

## Config

Either run `git_mirror init` to interactively setup the config, or add a section to `~/git_mirror.toml`.

```toml
[tool.git-mirror.github]
user_name = "matthewdeanmartin"
pypi_owner_name = "Matthew Martin"
target_dir = "f:/github/"
include_private = false
include_forks = false

[tool.git-mirror.gitlab]
user_name = "matthewdeanmartin"
url = "http://gitlab.com"
pypi_owner_name = "Matthew Martin"
target_dir = "f:/gitlab/"
include_private = true
include_forks = false
group_id = 542

[tool.git-mirror.selfhosted]
type = "gitlab"
user_name = "mmartin"
url = "http://git.example.com"
pypi_owner_name = "Matthew Martin"
target_dir = "e:/self/"
include_private = true
include_forks = false
```

## Examples

```bash
git_mirror clone-all # Clone everything to target directory, unless it already exists
git_mirror pull-all # Execute pull on all repos.
git_mirror local-changes # Show local, uncommitted, unpushed changes
git_mirror not-repo # Show what stray folders in the target folder have accumulated that aren't even repos.
git_mirror build-status # What github actions are failing, passing.
git_mirror sync-config  # Copy the list of all your repos to the config file so you can mark them for ignore or tag them.
```

## Prior Art

Do actions across multiple repos

- [gita](https://github.com/nosarthur/gita) - multi-repo git tool
- [mani](https://github.com/alajmo/mani) - Stores bash snippets in a yaml file. Rust
- [meta](https://github.com/mateodelnorte/meta) - Node based

[See also this huge list of similar tools](https://myrepos.branchable.com/)

Do git host things on the command line

- [gh](https://cli.github.com/) - github cli
- [glab](https://docs.gitlab.com/ee/editor_extensions/gitlab_cli/) - gitlab cli

## Documentation

- [TODO](https://github.com/matthewdeanmartin/git_mirror/blob/main/docs/TODO.md)

