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.2.tar.gz (7.5 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.2-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kira_setup-0.2.2.tar.gz
  • Upload date:
  • Size: 7.5 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.2.tar.gz
Algorithm Hash digest
SHA256 f8c721c4ed4dae05e5965a0c516bfca057e9ad0fac083713b49d2f91d040df10
MD5 b53ec7e90ae4feeabe68e4d8377c08ad
BLAKE2b-256 b032bdd5d7d26cb42ff035e240e58ac75947673284bc1c6c684f4e84650011be

See more details on using hashes here.

Provenance

The following attestation bundles were made for kira_setup-0.2.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: kira_setup-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 9.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 98c5ff316a02ad0537e427a516f6fbf9ff17a20a044e645f008ed8ef492c101c
MD5 a02bb01a99301d4296697b2eff365b5b
BLAKE2b-256 4a037d2061d29666eb3b96865cc29cc9060e745fd645a52b11f4df2992fc8d42

See more details on using hashes here.

Provenance

The following attestation bundles were made for kira_setup-0.2.2-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