ol-concourse-lib
A Python DSL for programmatically building Concourse CI/CD pipelines.
Instead of writing YAML files by hand, use typed Python classes to construct type-safe pipeline definitions that serialize to valid Concourse pipeline YAML.
Installation
pip install ol-concourse-lib
# or with Pulumi job builder support:
pip install "ol-concourse-lib[pulumi]"
Quick Start
from ol_concourse.lib.models.pipeline import Identifier
from ol_concourse.lib.resources import git_repo, registry_image
from ol_concourse.lib.resource_types import packer_build
from ol_concourse.lib.jobs.infrastructure import packer_jobs
import yaml, json
# Build a pipeline fragment for packer AMI builds
code = git_repo(
name=Identifier("packer-templates"),
uri="https://github.com/myorg/packer-templates",
branch="main",
)
fragment = packer_jobs(
dependencies=[],
image_code=code,
node_types=["web", "worker"],
)
pipeline = fragment.to_pipeline()
print(yaml.dump(json.loads(pipeline.model_dump_json())))
API
Models (ol_concourse.lib.models)
Pipeline— root pipeline definitionJob,Resource,ResourceType— core pipeline componentsGetStep,PutStep,TaskStep,InParallelStep— step typesTaskConfig,Command,Input,Output— task configurationPipelineFragment— composable pipeline unit
Builder Functions
| Module | Functions |
|---|---|
ol_concourse.lib.resources |
git_repo, registry_image, github_issues, schedule, s3_object, … |
ol_concourse.lib.resource_types |
packer_build, packer_validate, pulumi_provisioner_resource, github_issues_resource, github_deployments_resource, release_resource_type, … |
ol_concourse.lib.jobs.infrastructure |
packer_jobs, pulumi_jobs_chain, pulumi_job |
ol_concourse.lib.containers |
container_build_task |
ol_concourse.lib.notifications |
notification (Slack) |
ol_concourse.lib.tasks |
instance_refresh_task, block_for_instance_refresh_task |
Regenerating Pipeline Models
models/pipeline.py is generated from the Concourse pipeline JSON schema:
pip install datamodel-code-generator
datamodel-codegen \
--url https://raw.githubusercontent.com/nicholasdille/concourse-jsonschema/main/concourse.json \
--output src/ol_concourse/lib/models/pipeline.py \
--output-model-type pydantic_v2.BaseModel
License
BSD-3-Clause — Copyright MIT Open Learning
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ol_concourse-0.9.0.tar.gz.
File metadata
- Download URL: ol_concourse-0.9.0.tar.gz
- Upload date:
- Size: 54.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec2f0d895f1bcaa213c74e62cb6571260d8f68cc59513d90f38d296ff1a4abc0
|
|
| MD5 |
49e2e5052d688252b16850a74d140a0d
|
|
| BLAKE2b-256 |
9a13a1c72ddf3701e42316a29db677a323886bccac6976a4371b101275e07842
|
File details
Details for the file ol_concourse-0.9.0-py3-none-any.whl.
File metadata
- Download URL: ol_concourse-0.9.0-py3-none-any.whl
- Upload date:
- Size: 52.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d1d353b4009db13db8dab829074fc4c279ec1f172d945d2d2d64b5ced639c41e
|
|
| MD5 |
cb3a2631c67d917aea0244186c74874f
|
|
| BLAKE2b-256 |
0621deadd443bfced2ffc8c9b736635c47eee72258145b8692713b05f8941d4d
|
