Skip to content

Commit 91c74d7

Browse files
btr1975btr1975
authored
Feature/overide sub map val (#1)
* added self extracting maps when tar.gz is found in maps * added a global option for sub maps * updated some of the docs
1 parent 7a050c7 commit 91c74d7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+676
-279
lines changed

‎docs/gh-pages/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 28b8ef72f428ce31bf23a25a2795e015
3+
config: 33c456dd7a07e9edcc26ade5dd733220
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/gh-pages/.buildinfo.bak

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 7398ea610ddcde731dd338352ceddb46
3+
config: 28b8ef72f428ce31bf23a25a2795e015
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/gh-pages/.doctrees/environment.pickle

2.17 KB
Binary file not shown.

‎docs/gh-pages/.doctrees/index.doctree

587 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/code/modules.doctree

-3 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/code/pod_porter.doctree

-78 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/code/pod_porter.render.doctree

-77 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/code/pod_porter.util.doctree

-96 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/directions/index.doctree

-3 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/directions/map-structure.doctree

823 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/directions/maps.doctree

-6 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/directions/templates.doctree

-24 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/directions/the-cli.doctree

-3 Bytes
Binary file not shown.

‎docs/gh-pages/.doctrees/source/directions/values.doctree

3.75 KB
Binary file not shown.

‎docs/gh-pages/_modules/index.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Overview: module code &mdash; pod-porter v0.1.2 0.1.2 documentation</title>
9-
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
8+
<title>Overview: module code &mdash; pod-porter v0.2.0 0.2.0 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
1010
<link rel="stylesheet" type="text/css" href="../_static/css/my_theme.css?v=f7a27adb" />
1111

1212

1313
<script src="../_static/jquery.js?v=5d32c60e"></script>
1414
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../_static/documentation_options.js?v=92734c54"></script>
15+
<script src="../_static/documentation_options.js?v=938c9ccc"></script>
1616
<script src="../_static/doctools.js?v=9bcbadda"></script>
1717
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1818
<script type="module" src="https://cdn.jsdelivr.net/npm/mermaid@11.2.0/dist/mermaid.esm.min.mjs"></script>
@@ -66,7 +66,7 @@
6666

6767

6868
<a href="../index.html" class="icon icon-home">
69-
pod-porter v0.1.2
69+
pod-porter v0.2.0
7070
</a>
7171
<div role="search">
7272
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -88,7 +88,7 @@
8888

8989
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #2980B9" >
9090
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
91-
<a href="../index.html">pod-porter v0.1.2</a>
91+
<a href="../index.html">pod-porter v0.2.0</a>
9292
</nav>
9393

9494
<div class="wy-nav-content">
@@ -121,7 +121,7 @@ <h1>All modules for which code is available</h1>
121121
<hr/>
122122

123123
<div role="contentinfo">
124-
<p>&#169; Copyright Copyright (c) 2024 Benjamin P. Trachtenberg.</p>
124+
<p>&#169; Copyright Copyright (c) 2024-2025 Benjamin P. Trachtenberg.</p>
125125
</div>
126126

127127
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/gh-pages/_modules/pod_porter/pod_porter.html

Lines changed: 101 additions & 53 deletions
Large diffs are not rendered by default.

‎docs/gh-pages/_modules/pod_porter/pod_porter_cli.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>pod_porter.pod_porter_cli &mdash; pod-porter v0.1.1 0.1.1 documentation</title>
9-
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
8+
<title>pod_porter.pod_porter_cli &mdash; pod-porter v0.2.0 0.2.0 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/css/my_theme.css?v=f7a27adb" />
1111

1212

1313
<script src="../../_static/jquery.js?v=5d32c60e"></script>
1414
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../../_static/documentation_options.js?v=a58bc63e"></script>
15+
<script src="../../_static/documentation_options.js?v=938c9ccc"></script>
1616
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1717
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1818
<script type="module" src="https://cdn.jsdelivr.net/npm/mermaid@11.2.0/dist/mermaid.esm.min.mjs"></script>
@@ -66,7 +66,7 @@
6666

6767

6868
<a href="../../index.html" class="icon icon-home">
69-
pod-porter v0.1.1
69+
pod-porter v0.2.0
7070
</a>
7171
<div role="search">
7272
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -88,7 +88,7 @@
8888

8989
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #2980B9" >
9090
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
91-
<a href="../../index.html">pod-porter v0.1.1</a>
91+
<a href="../../index.html">pod-porter v0.2.0</a>
9292
</nav>
9393

9494
<div class="wy-nav-content">
@@ -111,15 +111,15 @@ <h1>Source code for pod_porter.pod_porter_cli</h1><div class="highlight"><pre>
111111
<span class="sd">CLI for pod_porter</span>
112112
<span class="sd">&quot;&quot;&quot;</span>
113113

114-
<span class="kn">from</span> <span class="nn">argparse</span> <span class="kn">import</span> <span class="n">ArgumentParser</span>
115-
<span class="kn">from</span> <span class="nn">pod_porter.pod_porter</span> <span class="kn">import</span> <span class="n">PorterMapsRunner</span>
116-
<span class="kn">from</span> <span class="nn">pod_porter.util.file_read_write</span> <span class="kn">import</span> <span class="n">write_file</span><span class="p">,</span> <span class="n">create_tar_gz_file</span><span class="p">,</span> <span class="n">extract_tar_gz_file</span><span class="p">,</span> <span class="n">create_new_map</span>
117-
<span class="kn">from</span> <span class="nn">pod_porter.version</span> <span class="kn">import</span> <span class="n">__version__</span> <span class="k">as</span> <span class="n">pod_porter_version</span>
114+
<span class="kn">from</span><span class="w"> </span><span class="nn">argparse</span><span class="w"> </span><span class="kn">import</span> <span class="n">ArgumentParser</span>
115+
<span class="kn">from</span><span class="w"> </span><span class="nn">pod_porter.pod_porter</span><span class="w"> </span><span class="kn">import</span> <span class="n">PorterMapsRunner</span>
116+
<span class="kn">from</span><span class="w"> </span><span class="nn">pod_porter.util.file_read_write</span><span class="w"> </span><span class="kn">import</span> <span class="n">write_file</span><span class="p">,</span> <span class="n">create_tar_gz_file</span><span class="p">,</span> <span class="n">extract_tar_gz_file</span><span class="p">,</span> <span class="n">create_new_map</span>
117+
<span class="kn">from</span><span class="w"> </span><span class="nn">pod_porter.version</span><span class="w"> </span><span class="kn">import</span> <span class="n">__version__</span> <span class="k">as</span> <span class="n">pod_porter_version</span>
118118

119119

120120
<div class="viewcode-block" id="common_sub_parser_map_arguments">
121121
<a class="viewcode-back" href="../../source/code/pod_porter.html#pod_porter.pod_porter_cli.common_sub_parser_map_arguments">[docs]</a>
122-
<span class="k">def</span> <span class="nf">common_sub_parser_map_arguments</span><span class="p">(</span><span class="n">sub_arg_parser</span><span class="p">:</span> <span class="n">ArgumentParser</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
122+
<span class="k">def</span><span class="w"> </span><span class="nf">common_sub_parser_map_arguments</span><span class="p">(</span><span class="n">sub_arg_parser</span><span class="p">:</span> <span class="n">ArgumentParser</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
123123
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add common arguments to a sub parser</span>
124124

125125
<span class="sd"> :type sub_arg_parser: ArgumentParser</span>
@@ -134,7 +134,7 @@ <h1>Source code for pod_porter.pod_porter_cli</h1><div class="highlight"><pre>
134134

135135
<div class="viewcode-block" id="common_sub_parser_arguments">
136136
<a class="viewcode-back" href="../../source/code/pod_porter.html#pod_porter.pod_porter_cli.common_sub_parser_arguments">[docs]</a>
137-
<span class="k">def</span> <span class="nf">common_sub_parser_arguments</span><span class="p">(</span><span class="n">sub_arg_parser</span><span class="p">:</span> <span class="n">ArgumentParser</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
137+
<span class="k">def</span><span class="w"> </span><span class="nf">common_sub_parser_arguments</span><span class="p">(</span><span class="n">sub_arg_parser</span><span class="p">:</span> <span class="n">ArgumentParser</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
138138
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add common arguments to a sub parser</span>
139139

140140
<span class="sd"> :type sub_arg_parser: ArgumentParser</span>
@@ -157,7 +157,7 @@ <h1>Source code for pod_porter.pod_porter_cli</h1><div class="highlight"><pre>
157157

158158
<div class="viewcode-block" id="common_sub_parser_output_path">
159159
<a class="viewcode-back" href="../../source/code/pod_porter.html#pod_porter.pod_porter_cli.common_sub_parser_output_path">[docs]</a>
160-
<span class="k">def</span> <span class="nf">common_sub_parser_output_path</span><span class="p">(</span><span class="n">sub_arg_parser</span><span class="p">:</span> <span class="n">ArgumentParser</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
160+
<span class="k">def</span><span class="w"> </span><span class="nf">common_sub_parser_output_path</span><span class="p">(</span><span class="n">sub_arg_parser</span><span class="p">:</span> <span class="n">ArgumentParser</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
161161
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add common arguments to a sub parser</span>
162162

163163
<span class="sd"> :type sub_arg_parser: ArgumentParser</span>
@@ -172,7 +172,7 @@ <h1>Source code for pod_porter.pod_porter_cli</h1><div class="highlight"><pre>
172172

173173
<div class="viewcode-block" id="cli_argument_parser">
174174
<a class="viewcode-back" href="../../source/code/pod_porter.html#pod_porter.pod_porter_cli.cli_argument_parser">[docs]</a>
175-
<span class="k">def</span> <span class="nf">cli_argument_parser</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">ArgumentParser</span><span class="p">:</span>
175+
<span class="k">def</span><span class="w"> </span><span class="nf">cli_argument_parser</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">ArgumentParser</span><span class="p">:</span>
176176
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Function to create the argument parser</span>
177177

178178
<span class="sd"> :rtype: ArgumentParser</span>
@@ -221,7 +221,7 @@ <h1>Source code for pod_porter.pod_porter_cli</h1><div class="highlight"><pre>
221221

222222
<div class="viewcode-block" id="cli">
223223
<a class="viewcode-back" href="../../source/code/pod_porter.html#pod_porter.pod_porter_cli.cli">[docs]</a>
224-
<span class="k">def</span> <span class="nf">cli</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
224+
<span class="k">def</span><span class="w"> </span><span class="nf">cli</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
225225
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Function to run the command line</span>
226226

227227
<span class="sd"> :rtype: None</span>
@@ -282,7 +282,7 @@ <h1>Source code for pod_porter.pod_porter_cli</h1><div class="highlight"><pre>
282282
<hr/>
283283

284284
<div role="contentinfo">
285-
<p>&#169; Copyright Copyright (c) 2024 Benjamin P. Trachtenberg.</p>
285+
<p>&#169; Copyright Copyright (c) 2024-2025 Benjamin P. Trachtenberg.</p>
286286
</div>
287287

288288
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

0 commit comments

Comments
 (0)