Skip to main content

Manage nested git repositories in Gitlab seemlessly(ish)

Project description

gitconductor

![tests] Coverage License ![Ruff] Documentation PyPI Python versions

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.

Documentation.

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:

  1. Login to Gitlab.
  2. Click to user icon.
  3. Click preferences in the drop down.
  4. Click "Personal access tokens" on the left side bar.
  5. Click the "Add new token" button in the top right.
  6. Give it a helpful name.
  7. Set the expiry date - for closed systems the longest permissable time of 1 year is easiest.
  8. Click the tick box for:
    • read_user
    • read_repository
    • read_virtual_registry
    • read_registry
    • read_api
    • self_rotate
  9. Click the "Generate token" button below.
  10. 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:

  1. Via an environment variable: export GITCONDUCTOR_GITLAB_API_KEY=<my-private-key>
  2. Via the "gitconductor.toml" file in the gitconductor_gitlab_api_key variable.

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


Download files

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

Source Distribution

gitconductor-0.3.0.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitconductor-0.3.0-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file gitconductor-0.3.0.tar.gz.

File metadata

  • Download URL: gitconductor-0.3.0.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

Hashes for gitconductor-0.3.0.tar.gz
Algorithm Hash digest
SHA256 666f571776acbfb32022f78d95581cb1bb09011e9a23caf781fe5401f77dba7e
MD5 f7113626e9614242d051ec06c3823846
BLAKE2b-256 ab25b0646b3fa34e594afdaf0286b911cd3ec577b305c55d2d9150b618c46881

See more details on using hashes here.

File details

Details for the file gitconductor-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: gitconductor-0.3.0-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

Hashes for gitconductor-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7c1697cf0162f58228c090b8289f66a102c83005f8aaa19b8b7e281e4869d6b
MD5 4f465e113a5066e8311cfd00e7056238
BLAKE2b-256 5cd710924d2ac60fd9a61564496f5769c0354c8738cbf4edb43f0d3f1bb5432e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page