Skip to main content

Keep repos organized locally the same as on GitLab

Project description

PolyRepo

Keep repos organized locally the same as on GitLab

Bird icons created by Mihimihi - Flaticon

Installation and Use

As a WIP, PolyRepo supports only the groups command, which lists a group and all its subgroups.

To install: pipx install polyrepo

To configure, create a ~/.polyrepo.yml file that looks like this:

gitlab:
  host: gitlab.com
  token: glpat-aaaaaaaaaaaaaaaaaaaa

(The token is optional if you're just pulling public groups/subgroups)

Then:

polyrepo groups gitlab-org

... with the path to the group you want to examine.

Proposed functionality

polyrepo sync steampunk-wizard

In a subdirectory called steampunk-wizard, clone all its subgroups and projects.

If a subdirectory doesn't exist, create it to hold the clone.

If a subdirectory exists for a project:

  1. Confirm that the default git remote points to the correct path in GitLab
  2. Optionally, fetch everything, including tags

If a subdirectory exists that does NOT correspond to a GitLab repo, remove it?

Output in text

/steampunk-wizard/busy                 Created
/steampunk-wizard/labcrawler           Disjoin
/steampunk-wizard/mypyref              Correct  Changed  
/steampunk-wizard/sandbox/ci-sandbox   Fetched
/steampunk-wizard/sandbox/play-around  Missing

Statuses:

  • Created The repo did not previously exist locally, and now has been cloned and fetched.
  • Fetched The repo did exist, and has been fetched
  • Correct Was already up to date; no changes
  • Missing There is no repo in GitLab, but there's a local folder with content
  • Disjoin A local directory exists, but either isn't a git repo or has the wrong default remote

Then Changed means local changes exist, which could include

  • Local branches still to be pushed
  • Commits in a branch beyond what was fetched
  • Local changes to be committed

Note that PolyRepo doesn't pull or merge anything, doesn't touch the working directory except in the case of creation, and ...

There's a .polyrepo file (optional) to specify the subgroups/repos to consider.

Questions

  • How to handle moves of repos between namespaces?
  • Any operation to polyrepo every namespace the user can access?

Development

make clear
poetry install
export GITLAB_TOKEN=$(op item get "Gitlab.com (personal) [2FA]" --fields label=/steampunk-wizard)
python -m polyrepo --config test/files/.polyrepo.yml groups steampunk-wizard

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

polyrepo-0.3.2.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

polyrepo-0.3.2-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file polyrepo-0.3.2.tar.gz.

File metadata

  • Download URL: polyrepo-0.3.2.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.11.6 Linux/5.4.109+

File hashes

Hashes for polyrepo-0.3.2.tar.gz
Algorithm Hash digest
SHA256 da4444938b642168ebcf461b91c0bac3e27cea9a36a2b20c421cb4c37a490182
MD5 9218e89ef71c2493d04b77bd3512fb38
BLAKE2b-256 cb06fc65e013c4d237cd8f7c86c2fe5ede892559471897ed4e9bbe9238074d30

See more details on using hashes here.

File details

Details for the file polyrepo-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: polyrepo-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.11.6 Linux/5.4.109+

File hashes

Hashes for polyrepo-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dd366b48806c1647d7e6056bcb6eeb9bb7745c063adcb0b4604631d4263be38b
MD5 9ceb4b55212510fecfa43d117d5ddbdc
BLAKE2b-256 0490d7772aee00583999c2017cd31d09cd7d8eb94bcf13127c4de55d53c58b96

See more details on using hashes here.

Supported by

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