Skip to main content

A tool to parse rockerc.yaml files and pass on the arguments onto rocker

Project description

rockerc

Continuous Integration Status

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

Installation

Recommended Method:

Install pipx (if not already installed):

sudo apt install pipx
pipx ensurepath

Then install rockerc and its dependencies globally with:

pipx install --include-deps rockerc

to develop run

pipx install --include-deps . --force

This will ensure that rockerc and rocker commands are available on your PATH.

Usage

navigate to a directory with a rockerc.yaml file and run:

rockerc 

This will search recursively for rockerc.yaml and pass those arguments to rocker

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 functionality 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 implemented 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

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

rockerc-0.10.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

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

rockerc-0.10.0-py2.py3-none-any.whl (6.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file rockerc-0.10.0.tar.gz.

File metadata

  • Download URL: rockerc-0.10.0.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for rockerc-0.10.0.tar.gz
Algorithm Hash digest
SHA256 b69c1dfd608c633cdb24514ee9849cc926601e0a89ee2bd6ee9f03fd9c83b32b
MD5 9958d98e9a8bb90d2487ab3fc61ea2ba
BLAKE2b-256 32ba31d5e7fc760652ba86072ec8b11a3502c6b367c7cfe2065e3cc2ace0115c

See more details on using hashes here.

File details

Details for the file rockerc-0.10.0-py2.py3-none-any.whl.

File metadata

  • Download URL: rockerc-0.10.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for rockerc-0.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 084d61dbccb2d273b983745b3d6d4cabe6f22e4f1bcb8e50c07172b11590fe5f
MD5 4233ec21317bb0d41ac91f42678cc3c3
BLAKE2b-256 fbb2800f8b71fac14813450ffa8f2a99eb6b09cd1552fc5833cd26b906171c40

See more details on using hashes here.

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