gitforge 0.1.0

Git Forge API Client..

GIT FORGE API CLIENTS

W.I.P. API clients for GitHub & GitLab.

INSTALLATION

pip install gitforge

CONFIGURATION

On first run you will be asked to enter a destination directory to sync to or check the status of. You will also be asked to enter your Personal Access Token.

Generate a GitHub Personal Access Token here.

Generate a GitLab Personal Access Token here.

These details will be stored in site.USER_BASE/share/gitforge/config, which, in a POSIX environment, is usually ~/.local/share/gitforge/config. I'm actually not sure where Python's site.USER_BASE is on Windows. Probably somewhere in AppData..

The configuration looks something like this:

[GitHub]
destination = /path/to/directory/to/store/repos
token = GITHUB-PERSONAL-ACCESS-TOKEN

[GitLab]
destination = /path/to/directory/to/store/repos
token = GITLAB-PERSONAL-ACCESS-TOKEN

These defaults can be overridden on the command line with the --token and --destination arguments. See below for more details.

COMMANDS

sync: Clone repositories (and groups in the case of GitLab) to destination. If they already exist in destination - update them to the latest remote commit.

status: Check repositories in destination for uncommitted changes.

jobs: GitLab ONLY View the log of the last failed CI job run in repository.

schedules: GitLab ONLY View all CI pipeline schedules ordered by next run time.

members: GitLab ONLY View all members of groups or projects and their access level.

N.B. If no repositories or groups are specified with -r or -g, then run command against all of them... This may take a while depending on how many repositories you have in your account.

OPTIONS

GITHUB

usage: gh [-h] [-d DESTINATION] [-i] [-p {ssh,http}] [-r REPOS [REPOS ...]]
          [-t TOKEN] [-v]
          [{sync,status,jobs,schedules}]

CLI GitHub API Client

positional arguments:
  {sync,status}
                        command to run (default: sync)

optional arguments:
  -d DESTINATION, --destination DESTINATION
                        destination path (default: None)
  -h, --help            show this help message and exit
  -i, --interactive     choose repos interactively (default: False)
  -p {ssh,http}, --protocol {ssh,http}
                        protocol to use (default: ssh)
  -r REPOS [REPOS ...], --repos REPOS [REPOS ...]
                        GitHub repo names (default: None)
  -t TOKEN, --token TOKEN
                        GitHub personal access token (default: None)
  -v, --verbosity       increase verbosity (default: 0)

GITLAB

usage: gl [-h] [-d DESTINATION] [-i] [-p {ssh,http}] [-r REPOS [REPOS ...]]
          [-t TOKEN] [-v] [-g GROUPS [GROUPS ...]]
          [{sync,status,jobs,schedules}]

CLI GitLab API Client

positional arguments:
  {sync,status,jobs,schedules,members}
                        command to run (default: sync)

optional arguments:
  -d DESTINATION, --destination DESTINATION
                        destination path (default: None)
  -g GROUPS [GROUPS ...], --groups GROUPS [GROUPS ...]
                        gitlab group names (default: None)
  -h, --help            show this help message and exit
  -i, --interactive     choose repos interactively (default: False)
  -p {ssh,http}, --protocol {ssh,http}
                        protocol to use (default: ssh)
  -r REPOS [REPOS ...], --repos REPOS [REPOS ...]
                        GitLab repo names (default: None)
  -t TOKEN, --token TOKEN
                        GitLab personal access token (default: None)
  -v, --verbosity       increase verbosity (default: 0)

EXAMPLES

View job logs of latest failed GitLab CI job in "project-1" & "project-2" repository

gitlab jobs -r project-1 project-2

Pipe this to less -Rr for maximum win:

gitlab -r project-1 project-2 jobs | less -Rr

Bosh.

View CI pipeline schedules of all projects in "group-name" group

gitlab schedules -g group-name

View all members of "group-name" and "project-name"

gitlab members -g group-name -r project-name