neurodocker.reproenv.renderers module

Container specification renderers.

class neurodocker.reproenv.renderers.DockerRenderer(pkg_manager: Literal[apt, yum], users: Optional[Set[str]] = None)[source]

Bases: neurodocker.reproenv.renderers._Renderer

arg(key: str, value: Optional[str] = None)neurodocker.reproenv.renderers.DockerRenderer[source]

Add a Dockerfile ARG instruction.

copy(source: Union[List[os.PathLike], os.PathLike], destination: os.PathLike, from_: Optional[str] = None, chown: Optional[str] = None)neurodocker.reproenv.renderers.DockerRenderer[source]

Add a Dockerfile COPY instruction.

entrypoint(args: List[str])neurodocker.reproenv.renderers.DockerRenderer[source]
env(**kwds: Mapping[str, str])neurodocker.reproenv.renderers.DockerRenderer[source]

Add a Dockerfile ENV instruction.

from_(base_image: str, as_: Optional[str] = None)neurodocker.reproenv.renderers.DockerRenderer[source]

Add a Dockerfile FROM instruction.

install(pkgs: List[str], opts=None)neurodocker.reproenv.renderers.DockerRenderer[source]

Install system packages.

label(**kwds: Mapping[str, str])neurodocker.reproenv.renderers.DockerRenderer[source]

Add a Dockerfile LABEL instruction.

run(command: str)neurodocker.reproenv.renderers.DockerRenderer[source]

Add a Dockerfile RUN instruction.

user(user: str)neurodocker.reproenv.renderers.DockerRenderer[source]

Add a Dockerfile USER instruction. If the user is not in self.users, then a RUN instruction that creates the user will also be added.

workdir(path: os.PathLike)neurodocker.reproenv.renderers.DockerRenderer[source]

Add a Dockerfile WORKDIR instruction.

class neurodocker.reproenv.renderers.SingularityRenderer(pkg_manager: Literal[apt, yum], users: Optional[Set[str]] = None)[source]

Bases: neurodocker.reproenv.renderers._Renderer

arg(key: str, value: Optional[str] = None)neurodocker.reproenv.renderers.SingularityRenderer[source]
copy(source: Union[List[os.PathLike], os.PathLike], destination: os.PathLike)neurodocker.reproenv.renderers.SingularityRenderer[source]
entrypoint(args: List[str])neurodocker.reproenv.renderers.SingularityRenderer[source]
env(**kwds: Mapping[str, str])neurodocker.reproenv.renderers.SingularityRenderer[source]
from_(base_image: str)neurodocker.reproenv.renderers.SingularityRenderer[source]
install(pkgs: List[str], opts=None)neurodocker.reproenv.renderers.SingularityRenderer[source]

Install system packages.

label(**kwds: Mapping[str, str])neurodocker.reproenv.renderers.SingularityRenderer[source]
run(command: str)neurodocker.reproenv.renderers.SingularityRenderer[source]
user(user: str)neurodocker.reproenv.renderers.SingularityRenderer[source]
workdir(path: os.PathLike)neurodocker.reproenv.renderers.SingularityRenderer[source]