Skip to main content

Kira's CLI to setup new projects

Project description

Kira Setup Bot

wemake.services kira-family Build Status wemake-python-styleguide Dependencies Status

CLI utility to automate routine work with new projects.

Part of the @kira bots family.

kira-setup does not create a repository. It configures an existing GitLab project so new repositories start with the same engineering standards.

Features

  • Configures GitLab project defaults for a stricter merge flow
  • Requires passing pipelines before merge
  • Requires all discussions to be resolved before merge
  • Sets fast-forward only merge strategy
  • Configures merge request approval rules
  • Protects the master branch and release tags matching v*
  • Enforces push rules for branch names and commit messages
  • Prevents secret pushes and enables member checks
  • Creates a standard label set for triage and workflow
  • Configures container registry cleanup policy

Installation

Requirements:

  • Python 3.11+
  • An existing GitLab project
  • A GitLab access token with permission to manage project settings
pip install kira-setup

Quick Start

Run the CLI against an existing project:

kira-setup group-or-user/project-name --token YOUR_ACCESS_TOKEN

For self-hosted GitLab:

kira-setup group-or-user/project-name \
  --token YOUR_ACCESS_TOKEN \
  --domain gitlab.example.com

To skip specific setup steps, repeat --skip with the stable step name:

kira-setup group-or-user/project-name \
  --token YOUR_ACCESS_TOKEN \
  --skip labels \
  --skip protect-tags

Available --skip values:

  • star
  • configure
  • push-rules
  • approval-rules
  • labels
  • protect-branches
  • protect-tags
  • cleanup-policy

Why Use It

We use this CLI to make repository setup repeatable across projects. Instead of applying the same GitLab rules manually every time, kira-setup brings a new repository to the expected baseline in a single command.

Related Projects

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

kira_setup-0.2.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

kira_setup-0.2.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file kira_setup-0.2.0.tar.gz.

File metadata

  • Download URL: kira_setup-0.2.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for kira_setup-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d3427177103afdaab4a194348f76f2126cccb1d87fd72e7f235d26f2694da08d
MD5 e534800c5ce0d53afa282cc7dc49330f
BLAKE2b-256 bfbee2f4a43939bf2553269cf11ed27e5d55fcc1ba727710bc16aca235f580ed

See more details on using hashes here.

Provenance

The following attestation bundles were made for kira_setup-0.2.0.tar.gz:

Publisher: publish.yml on wemake-services/kira-setup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kira_setup-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: kira_setup-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for kira_setup-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45445b36989b6a9d27397e10822a0ba1be1280d2a6c41badba1f039c9c5d9da9
MD5 d8e3d548561db7fd2aecb5abb726946d
BLAKE2b-256 338d574abc0b97474e8314d7fa35be4497f35c347f82567fea28bcd15bb9f09e

See more details on using hashes here.

Provenance

The following attestation bundles were made for kira_setup-0.2.0-py3-none-any.whl:

Publisher: publish.yml on wemake-services/kira-setup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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