1+ <!doctype html>
2+ < html lang ="en ">
3+ < head >
4+ < meta charset ="utf-8 ">
5+ < meta name ="viewport " content ="width=device-width, initial-scale=1, minimum-scale=1 " />
6+ < meta name ="generator " content ="pdoc 0.9.2 " />
7+ < title > gcip.addons.docker.job_scripts API documentation</ title >
8+ < meta name ="description " content ="" />
9+ < link rel ="preload stylesheet " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css " integrity ="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs= " crossorigin >
10+ < link rel ="preload stylesheet " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css " integrity ="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg= " crossorigin >
11+ < link rel ="stylesheet preload " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css " crossorigin >
12+ < style > : root {--highlight-color : # fe9flex {display : flex !important }body {line-height : 1.5em }# content {padding : 20px }# sidebar {padding : 30px ;overflow : hidden}# sidebar > * : last-child {margin-bottom : 2cm }.http-server-breadcrumbs {font-size : 130% ;margin : 0 0 15px 0 }# footer {font-size : .75em ;padding : 5px 30px ;border-top : 1px solid # dddtext-align : right}# footer p {margin : 0 0 0 1em ;display : inline-block}# footer p : last-child {margin-right : 30px }h1 , h2 , h3 , h4 , h5 {font-weight : 300 }h1 {font-size : 2.5em ;line-height : 1.1em }h2 {font-size : 1.75em ;margin : 1em 0 .50em 0 }h3 {font-size : 1.4em ;margin : 25px 0 10px 0 }h4 {margin : 0 ;font-size : 105% }h1 : target , h2 : target , h3 : target , h4 : target , h5 : target , h6 : target {background : var (--highlight-color );padding : .2em 0 }a {color : # 058text-decoration : none;transition : color .3s ease-in-out}a : hover {color : # e82title code {font-weight : bold}h2 [id ^= "header-" ]{margin-top : 2em }.ident {color : # 900pre code {background : # f8f8f8font-size : .8em ;line-height : 1.4em }code {background : # f2f2f1padding : 1px 4px ;overflow-wrap : break-word}h1 code {background : transparent}pre {background : # f8f8f8border : 0 ;border-top : 1px solid # cccborder-bottom : 1px solid # cccmargin : 1em 0 ;padding : 1ex }# http-server-module-list {display : flex;flex-flow : column}# http-server-module-list div {display : flex}# http-server-module-list dt {min-width : 10% }# http-server-module-list p {margin-top : 0 }.toc ul , # index {list-style-type : none;margin : 0 ;padding : 0 }# index code {background : transparent}# index h3 {border-bottom : 1px solid # ddd# index ul {padding : 0 }# index h4 {margin-top : .6em ;font-weight : bold}@media (min-width : 200ex ){# index .two-column {column-count : 2 }}@media (min-width : 300ex ){# index .two-column {column-count : 3 }}dl {margin-bottom : 2em }dl dl : last-child {margin-bottom : 4em }dd {margin : 0 0 1em 3em }# header-classes + dl > dd {margin-bottom : 3em }dd dd {margin-left : 2em }dd p {margin : 10px 0 }.name {background : # eeefont-weight : bold;font-size : .85em ;padding : 5px 10px ;display : inline-block;min-width : 40% }.name : hover {background : # e0e0e0dt : target .name {background : var (--highlight-color )}.name > span : first-child {white-space : nowrap}.name .class > span : nth-child (2 ){margin-left : .4em }.inherited {color : # 999border-left : 5px solid # eeepadding-left : 1em }.inheritance em {font-style : normal;font-weight : bold}.desc h2 {font-weight : 400 ;font-size : 1.25em }.desc h3 {font-size : 1em }.desc dt code {background : inherit}.source summary , .git-link-div {color : # 666text-align : right;font-weight : 400 ;font-size : .8em ;text-transform : uppercase}.source summary > * white-space : nowrap;cursor : pointer}.git-link {color : inherit;margin-left : 1em }.source pre {max-height : 500px ;overflow : auto;margin : 0 }.source pre code {font-size : 12px ;overflow : visible}.hlist {list-style : none}.hlist li {display : inline}.hlist li : after {content : ',\2002' }.hlist li : last-child : after {content : none}.hlist .hlist {display : inline;padding-left : 1em }img {max-width : 100% }td {padding : 0 .5em }.admonition {padding : .1em .5em ;margin-bottom : 1em }.admonition-title {font-weight : bold}.admonition .note , .admonition .info , .admonition .important {background : # aefadmonition .todo , .admonition .versionadded , .admonition .tip , .admonition .hint {background : # dfdadmonition .warning , .admonition .versionchanged , .admonition .deprecated {background : # fd4admonition .error , .admonition .danger , .admonition .caution {background : lightpink}</ style >
13+ < style media ="screen and (min-width: 700px) "> @media screen and (min-width : 700px ){# sidebar {width : 30% ;height : 100vh ;overflow : auto;position : sticky;top : 0 }# content {width : 70% ;max-width : 100ch ;padding : 3em 4em ;border-left : 1px solid # dddpre code {font-size : 1em }.item .name {font-size : 1em }main {display : flex;flex-direction : row-reverse;justify-content : flex-end}.toc ul ul , # index ul {padding-left : 1.5em }.toc > ul > li {margin-top : .5em }}</ style >
14+ < style media ="print "> @media print{# sidebar h1 {page-break-before : always}.source {display : none}}@media print{* background : transparent !important ;color : # 000!important ;box-shadow : none !important ;text-shadow : none !important }a [href ]: after {content : " (" attr (href) ")" ;font-size : 90% }a [href ][title ]: after {content : none}abbr [title ]: after {content : " (" attr (title) ")" }.ir a : after , a [href ^= "javascript:" ]: after , a [href ^= "#" ]: after {content : "" }pre , blockquote {border : 1px solid # 999page-break-inside : avoid}thead {display : table-header-group}tr , img {page-break-inside : avoid}img {max-width : 100% !important }@page {margin : 0.5cm }p , h2 , h3 {orphans : 3 ;widows : 3 }h1 , h2 , h3 , h4 , h5 , h6 {page-break-after : avoid}}</ style >
15+ < script defer src ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js " integrity ="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8= " crossorigin > </ script >
16+ < script > window . addEventListener ( 'DOMContentLoaded' , ( ) => hljs . initHighlighting ( ) ) </ script >
17+ </ head >
18+ < body >
19+ < main >
20+ < article id ="content ">
21+ < header >
22+ < h1 class ="title "> Module < code > gcip.addons.docker.job_scripts</ code > </ h1 >
23+ </ header >
24+ < section id ="section-intro ">
25+ < details class ="source ">
26+ < summary >
27+ < span > Expand source code</ span >
28+ </ summary >
29+ < pre > < code class ="python "> from gcip.core.job import Job
30+
31+ __author__ = "Thomas Steinbach"
32+ __copyright__ = "Copyright 2020 DB Systel GmbH"
33+ __credits__ = ["Thomas Steinbach"]
34+ # SPDX-License-Identifier: Apache-2.0
35+ __license__ = 'Apache-2.0'
36+ __maintainer__ = 'Thomas Steinbach'
37+ __email__ = 'thomas.t.steinbach@deutschebahn.com'
38+
39+
40+ def build(
41+ *,
42+ repository: str,
43+ tag: str = "latest",
44+ context: str = ".",
45+ ) -> Job:
46+ """Runs `docker build`
47+
48+ Args:
49+ repository (str): The Docker repository name ([<registry>/]<image>). Defaults to None.
50+ tag (str): A Docker image tag applied to the image. Defaults to `latest`.
51+ context (str): The Docker build context (the directory containing the Dockerfile). Defaults to
52+ the current directory `.`.
53+
54+ Returns:
55+ A `Job` object doing the docker build.
56+ """
57+ return Job(
58+ name="docker",
59+ namespace="build",
60+ script=f"docker build -t {repository}:{tag} {context}",
61+ )</ code > </ pre >
62+ </ details >
63+ </ section >
64+ < section >
65+ </ section >
66+ < section >
67+ </ section >
68+ < section >
69+ < h2 class ="section-title " id ="header-functions "> Functions</ h2 >
70+ < dl >
71+ < dt id ="gcip.addons.docker.job_scripts.build "> < code class ="name flex ">
72+ < span > def < span class ="ident "> build</ span > </ span > (< span > *, repository: str, tag: str = 'latest', context: str = '.') ‑> < a title ="gcip.core.job.Job " href ="../../core/job.html#gcip.core.job.Job "> Job</ a > </ span >
73+ </ code > </ dt >
74+ < dd >
75+ < div class ="desc "> < p > Runs < code > docker < a title ="gcip.addons.docker.job_scripts.build " href ="#gcip.addons.docker.job_scripts.build "> build()</ a > </ code > </ p >
76+ < h2 id ="args "> Args</ h2 >
77+ < dl >
78+ < dt > < strong > < code > repository</ code > </ strong > : < code > str</ code > </ dt >
79+ < dd > The Docker repository name ([< registry > /]< image > ). Defaults to None.</ dd >
80+ < dt > < strong > < code > tag</ code > </ strong > : < code > str</ code > </ dt >
81+ < dd > A Docker image tag applied to the image. Defaults to < code > latest</ code > .</ dd >
82+ < dt > < strong > < code > context</ code > </ strong > : < code > str</ code > </ dt >
83+ < dd > The Docker build context (the directory containing the Dockerfile). Defaults to
84+ the current directory < code > .</ code > .</ dd >
85+ </ dl >
86+ < h2 id ="returns "> Returns</ h2 >
87+ < p > A < code > Job</ code > object doing the docker build.</ p > </ div >
88+ < details class ="source ">
89+ < summary >
90+ < span > Expand source code</ span >
91+ </ summary >
92+ < pre > < code class ="python "> def build(
93+ *,
94+ repository: str,
95+ tag: str = "latest",
96+ context: str = ".",
97+ ) -> Job:
98+ """Runs `docker build`
99+
100+ Args:
101+ repository (str): The Docker repository name ([<registry>/]<image>). Defaults to None.
102+ tag (str): A Docker image tag applied to the image. Defaults to `latest`.
103+ context (str): The Docker build context (the directory containing the Dockerfile). Defaults to
104+ the current directory `.`.
105+
106+ Returns:
107+ A `Job` object doing the docker build.
108+ """
109+ return Job(
110+ name="docker",
111+ namespace="build",
112+ script=f"docker build -t {repository}:{tag} {context}",
113+ )</ code > </ pre >
114+ </ details >
115+ </ dd >
116+ </ dl >
117+ </ section >
118+ < section >
119+ </ section >
120+ </ article >
121+ < nav id ="sidebar ">
122+ < h1 > Index</ h1 >
123+ < div class ="toc ">
124+ < ul > </ ul >
125+ </ div >
126+ < ul id ="index ">
127+ < li > < h3 > Super-module</ h3 >
128+ < ul >
129+ < li > < code > < a title ="gcip.addons.docker " href ="index.html "> gcip.addons.docker</ a > </ code > </ li >
130+ </ ul >
131+ </ li >
132+ < li > < h3 > < a href ="#header-functions "> Functions</ a > </ h3 >
133+ < ul class ="">
134+ < li > < code > < a title ="gcip.addons.docker.job_scripts.build " href ="#gcip.addons.docker.job_scripts.build "> build</ a > </ code > </ li >
135+ </ ul >
136+ </ li >
137+ </ ul >
138+ </ nav >
139+ </ main >
140+ < footer id ="footer ">
141+ < p > Generated by < a href ="https://pdoc3.github.io/pdoc "> < cite > pdoc</ cite > 0.9.2</ a > .</ p >
142+ </ footer >
143+ </ body >
144+ </ html >
0 commit comments