Skip to content
/ rockerc Public
generated from blooop/python_template

A wrapper around rocker that looks for a rockerc.yaml file and passes those arguments to rocker

License

Notifications You must be signed in to change notification settings

blooop/rockerc

Folders and files

NameName
Last commit message
Last commit date
Dec 4, 2024
Mar 1, 2025
Dec 10, 2024
Aug 30, 2024
Jan 25, 2025
Nov 2, 2024
Nov 22, 2024
Nov 2, 2024
Aug 30, 2024
Aug 30, 2024
Jan 25, 2025
Aug 30, 2024
Feb 5, 2025
Jan 25, 2025
Mar 1, 2025
Sep 16, 2024
Jan 25, 2025
Jan 25, 2025

Repository files navigation

rockerc

Continuous Integration Status

Ci Codecov GitHub issues GitHub pull-requests merged GitHub release PyPI - Downloads License Python Pixi Badge

Installation

Recommended Method:

Install uv and then install it as a globally available tool on your system

uv tool install rockerc 

Deprecated Method:

Globally install via pip, but this is not really recommended

pip install rockerc

Usage

#searches for rockerc.yaml and passes those arguments to rocker
rockerc 

Motivation

Rocker is an alternative to docker-compose that makes it easier to run containers with access to features of the local environment and add extra capabilities to existing docker images. However rocker has many configurable options and it can get hard to read or reuse those arguments. This is a naive wrapper that read a rockerc.yaml file and passes them to rocker. There are currently no plans to integrate docker-compose like functionalty directly into rocker so I made this as a proof of concept to see what the ergonomics of it would be like.

Caveats

I'm not sure this is the best way of implementing rockerc like functionality. It might be better to implmented it as a rocker extension, or in rocker itself. This was just the simplest way to get started. I may explore those other options in more detail in the future.

rocker.yaml configuration

You need to pass either a docker image, or a relative path to a dockerfile

rockerc.yaml

image: ubuntu:22.04

or

dockerfile: Dockerfile

will look for the dockerfile relative to the rockerc.yaml file