GCIP2
GCIP2 is a Python DSL for building GitLab CI/CD pipelines using strongly typed Pydantic models and a fluent builder API.
Instead of writing large YAML files, pipelines are defined in Python, validated against the official GitLab CI schema, and rendered into GitLab-compatible YAML.
Features
- Strongly typed GitLab CI models
- Fluent builder API
- Reusable job builders
- Pipeline inheritance
- JSON Schema validation
- Automatic YAML generation
- Dynamic pipeline discovery
- GitLab-compatible output
Installation
Create pyproject.toml with pyproject configuration
[project]
name = "dev"
version = "0.0.0"
description = ""
requires-python = ">=3.11,<4.0"
uv add gcip2
Quick Start
Initialize a new project:
dothat run init
This generates a minimal project structure:
.
├── ci.py
├── pyproject.toml
├── environment.toml
└── .pre-commit-config.yaml
Generate a child pipeline:
dothat run build-pipeline
or explicitly:
dothat run build-pipeline \
--ci-file ci.py \
--out-pipeline out/pipeline.gitlab-ci.yml
Generate the root .gitlab-ci.yml:
dothat run build-gitlab-ci
or
dothat run build-gitlab-ci \
--ci-file ci.py \
--out-gitlab-ci .gitlab-ci.yml
Documentation
Detailed documentation is available in the docs/ directory.
| Document | Description |
|---|---|
| docs/pipeline.md | Creating pipelines, jobs and workflow configuration |
| docs/builder.md | Pipeline builder, rendering and YAML generation |
| docs/pipeline_core.md | Reference for the typed GitLab CI models |
| docs/secrets.md | SecretsHandler with Vault integration |
| docs/project_config.md | ProjectConfig with global environment |
| CHANGELOG.md | Project changelog |
Project Structure
A typical project consists of two builders:
ci.py
├── Pipeline(PipelineBuilderImpl)
│ └── generates:
│ out/pipeline.gitlab-ci.yml
│
└── GitlabCi(GitlabCiBuilderImpl)
└── generates:
.gitlab-ci.yml
Pipeline defines the reusable downstream pipeline, while GitlabCi defines the repository's root GitLab CI configuration.
CLI
Initialize a project:
dothat run init
Force regeneration of template files:
dothat run init --force
Build a child pipeline:
dothat run build-pipeline
Build the repository .gitlab-ci.yml:
dothat run build-gitlab-ci
Validation
Generated pipelines can be validated against the bundled GitLab JSON schema before rendering.
External Links
- JSON Schema: https://json-schema.org/draft-07/json-schema-release-notes#keywords
- GitLab Pipeline Schema: https://gitlab.com/gitlab-org/gitlab-foss/-/raw/master/app/assets/javascripts/editor/schema/ci.json
- GitLab CI Documentation: https://docs.gitlab.com/ci/pipeline_editor/#view-full-configuration
License
Release files for gcip2 0.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gcip2-0.1.5.tar.gz | 101.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gcip2-0.1.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 159.7 kB
Release files / gcip2-0.1.5.tar.gz
| Download URL | gcip2-0.1.5.tar.gz |
|---|---|
| Size | 101.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ca33ce852f9c51af064ace349f7a435e25e4e024cd080d2a9a029989cff72389
|
|
BLAKE2b-256 checksum How to use checksums |
077442f2fc06902084ba4ee804ab62713089264fb9497f35da0db8e08a093532
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / gcip2-0.1.5-py3-none-any.whl
| Download URL | gcip2-0.1.5-py3-none-any.whl |
|---|---|
| Size | 58.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
556f04c35ad47485242e7e5ca0f3ecb48da4a3201c8ecffe015c983e4062acec
|
|
BLAKE2b-256 checksum How to use checksums |
045117c3253b96670857415c2c65afd00fce7496e714148804726c39ac07aa62
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|