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

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.8.0.tar.gz (7.9 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.8.0-py2.py3-none-any.whl (6.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for rockerc-0.8.0.tar.gz
Algorithm Hash digest
SHA256 66d1575caadb3e6500600b65572362fe109b4f7072f96679dd3c2b8168a63e74
MD5 379e30ada34574a60c09506e69755e92
BLAKE2b-256 96cba78b8f5b4ae53fd9fe3b8e586099be56f2077c650a0e31de4b9552694af3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rockerc-0.8.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.8.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 22b7e26879eb66120db9c5d60b6e9c76ed1caf17ebb8b24c11635480602b3216
MD5 f39795fad1e04dc54d6763de61252b1c
BLAKE2b-256 8c8536aed734658fb7b0803de9f33fa0edd79ce3f2602f1bcfda6dc81ad4f04c

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