Manage nested git repositories in Gitlab seemlessly(ish)
Project description
gitconductor
gitconductor is a command-line tool and Python library for managing git operations over nested GitLab groups using the official GitLab Python API. It makes it easier to traverse complex group/sub-group hierarchies, perform recursive git operations, without the need for submodule interdependencies, accessing only the sub-groups/projects for which the user has access.
Features
- Recursive group traversal — operate on entire GitLab group trees, not just individual projects
- Git operations across nested groups (clone, pull, status, etc.)
- Unified CLI and Python API
- Built on top of the official GitLab Python API
- Designed for automation, scripting, and bulk maintenance
Installation
pip install gitconductor
Gitlab Access
Access to Gitlab is controlled via Personal Access Tokens. To generate:
- Login to Gitlab.
- Click to user icon.
- Click preferences in the drop down.
- Click "Personal access tokens" on the left side bar.
- Click the "Add new token" button in the top right.
- Give it a helpful name.
- Set the expiry date - for closed systems the longest permissable time of 1 year is easiest.
- Click the tick box for:
- read_user
- read_repository
- read_virtual_registry
- read_registry
- read_api
- self_rotate
- Click the "Generate token" button below.
- Copy the new token (noting it can't be viewed again after).
Configuration
Configuration file
Gitconductor can store settings in a file. By default, this is at "~/.config/gitconductor/gitconductor.toml". The location can be changed via the GITCONDUCTOR_CONFIG environment variable. Alternatively, a path can be passed via the top-level --cfg CLI argument.
Environment Variables
GITCONDUCTOR_CONFIG: Gitconductor configuration YAML file location.GITCONDUCTOR_GITLAB_API_KEY: Gitlab Private Access Token.GITCONDUCTOR_GITLAB_URL: Gitlab main URL.
GitLab API Keys
Keys can be set up in two ways:
- Via an environment variable:
export GITCONDUCTOR_GITLAB_API_KEY=<my-private-key> - Via the "gitconductor.toml" file in the
gitconductor_gitlab_api_keyvariable.
Usage (CLI)
Clone
To clone a Gitlab project at, for example, https://gitlab.com/ejb90-group.
gitconductor clone ejb90-group
Branch
gitconductor branch <name>
Checkout
gitconductor checkout <name>
Pull
...
Visualisation
Tree
To visualise the hierarchy of Groups/Projects as a Run, run:
gitconductor viz tree
Results in:
ejb90-group
└── models
├── model-a
├── model-b
├── model-c
└── subgroup-1
├── model-a
└── model-b
Table
To visualise the hierarchy of Groups/Projects as a Table, run:
gitconductor viz table
Results in:
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Name ┃ Tree ┃ Branch ┃ Path ┃ Remote ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ model-a │ ejb90-group/models/model-a │ main │ ejb90-group/models/model-a │ git@gitlab.com:ejb90-group/models/model-a.git │
│ model-b │ ejb90-group/models/model-b │ main │ ejb90-group/models/model-b │ git@gitlab.com:ejb90-group/models/model-b.git │
│ model-c │ ejb90-group/models/model-c │ main │ ejb90-group/models/model-c │ git@gitlab.com:ejb90-group/models/model-c.git │
│ model-a │ ejb90-group/models/subgroup-1/model-a │ main │ ejb90-group/models/subgroup-1/model-a │ git@gitlab.com:ejb90-group/models/subgroup-1/subgroup-1-model-a.git │
│ model-b │ ejb90-group/models/subgroup-1/model-b │ main │ ejb90-group/models/subgroup-1/model-b │ git@gitlab.com:ejb90-group/models/subgroup-1/subgroup-1-model-b.git │
└───────────────┴───────────────────────────────────────┴────────┴───────────────────────────────────────┴─────────────────────────────────────────────────────────────────────┘
Access
To see who has access to a given hierarchy of Groups/Projects, run:
gitconductor viz access
Results in:
┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┓
┃ Group/Project ┃ User ┃ Access Level ┃ Public Email ┃ Expiry ┃
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━┩
│ ejb90-group │ Ellis │ Owner │ │ │
│ ejb90-group/models │ mobot │ Reporter │ │ │
└────────────────────┴───────┴──────────────┴──────────────┴────────┘
Usage (Python API)
group = gitlab.GitlabGroup(
gitlab_url=ctx.obj["url"],
gitlab_key=ctx.obj["key"],
name=name,
root=directory,
)
group.recursive_command("clone")
Development & Contributing
Contributions welcome — feel free to open issues or submit PRs.
License
MIT License • © 2026
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gitconductor-0.3.1.tar.gz.
File metadata
- Download URL: gitconductor-0.3.1.tar.gz
- Upload date:
- Size: 17.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
08c5f7ab6126e6ac2ddb65d4848dbde9b80b62fbf5482683ebadefecf6f5fdf3
|
|
| MD5 |
441b57d1ebf608a833970a87f5661368
|
|
| BLAKE2b-256 |
6b8a3e463baf72c80be1f099efecdb6b1a304997b856cdc191f7048608bbde63
|
File details
Details for the file gitconductor-0.3.1-py3-none-any.whl.
File metadata
- Download URL: gitconductor-0.3.1-py3-none-any.whl
- Upload date:
- Size: 19.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f8fd396b0a655ecc4b48d25558b61ce96b07efce84a58cc0907c16e1b7e7614d
|
|
| MD5 |
5aaca37ec5dd3c2189eb908cd6580879
|
|
| BLAKE2b-256 |
d27d7d0918415b9d93c8ce41627fdd13a7d26dfe9fd4578b5cc37361ce3a1903
|