nutri-matic 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. nutri_matic-0.1.2/LICENSE +21 -0
  2. nutri_matic-0.1.2/PKG-INFO +276 -0
  3. nutri_matic-0.1.2/README.md +230 -0
  4. nutri_matic-0.1.2/pyproject.toml +218 -0
  5. nutri_matic-0.1.2/setup.cfg +4 -0
  6. nutri_matic-0.1.2/src/nutri_matic.egg-info/PKG-INFO +276 -0
  7. nutri_matic-0.1.2/src/nutri_matic.egg-info/SOURCES.txt +61 -0
  8. nutri_matic-0.1.2/src/nutri_matic.egg-info/dependency_links.txt +1 -0
  9. nutri_matic-0.1.2/src/nutri_matic.egg-info/entry_points.txt +6 -0
  10. nutri_matic-0.1.2/src/nutri_matic.egg-info/requires.txt +31 -0
  11. nutri_matic-0.1.2/src/nutri_matic.egg-info/top_level.txt +1 -0
  12. nutri_matic-0.1.2/src/nutrimatic/__init__.py +24 -0
  13. nutri_matic-0.1.2/src/nutrimatic/__main__.py +19 -0
  14. nutri_matic-0.1.2/src/nutrimatic/build/__init__.py +23 -0
  15. nutri_matic-0.1.2/src/nutrimatic/build/ansible.py +8 -0
  16. nutri_matic-0.1.2/src/nutrimatic/build/readme.py +31 -0
  17. nutri_matic-0.1.2/src/nutrimatic/build/sphinx.py +105 -0
  18. nutri_matic-0.1.2/src/nutrimatic/build/yaml_front_matter.py +87 -0
  19. nutri_matic-0.1.2/src/nutrimatic/ccmeta/__init__.py +16 -0
  20. nutri_matic-0.1.2/src/nutrimatic/ccmeta/parser.py +25 -0
  21. nutri_matic-0.1.2/src/nutrimatic/cli/__init__.py +15 -0
  22. nutri_matic-0.1.2/src/nutrimatic/cli/build.py +54 -0
  23. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmbuild/__init__.py +16 -0
  24. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmbuild/readme.py +66 -0
  25. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmbuild/yaml_front_matter.py +51 -0
  26. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmconfig/__init__.py +14 -0
  27. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmconfig/config.py +37 -0
  28. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmtemplates/__init__.py +12 -0
  29. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmtemplates/generate.py +29 -0
  30. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmutils/__init__.py +20 -0
  31. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmutils/docs.py +58 -0
  32. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmutils/extract.py +62 -0
  33. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmutils/list.py +38 -0
  34. nutri_matic-0.1.2/src/nutrimatic/cli/commands/nmutils/run.py +46 -0
  35. nutri_matic-0.1.2/src/nutrimatic/cli/config.py +53 -0
  36. nutri_matic-0.1.2/src/nutrimatic/cli/main.py +81 -0
  37. nutri_matic-0.1.2/src/nutrimatic/cli/options/__init__.py +16 -0
  38. nutri_matic-0.1.2/src/nutrimatic/cli/options/verbose.py +30 -0
  39. nutri_matic-0.1.2/src/nutrimatic/cli/options/version.py +26 -0
  40. nutri_matic-0.1.2/src/nutrimatic/cli/templates.py +53 -0
  41. nutri_matic-0.1.2/src/nutrimatic/core/__init__.py +27 -0
  42. nutri_matic-0.1.2/src/nutrimatic/core/bash.py +47 -0
  43. nutri_matic-0.1.2/src/nutrimatic/core/config.py +96 -0
  44. nutri_matic-0.1.2/src/nutrimatic/core/github.py +77 -0
  45. nutri_matic-0.1.2/src/nutrimatic/core/logger.py +90 -0
  46. nutri_matic-0.1.2/src/nutrimatic/core/metadata.py +57 -0
  47. nutri_matic-0.1.2/src/nutrimatic/core/parser.py +8 -0
  48. nutri_matic-0.1.2/src/nutrimatic/core/template.py +8 -0
  49. nutri_matic-0.1.2/src/nutrimatic/hooks/__init__.py +9 -0
  50. nutri_matic-0.1.2/src/nutrimatic/hooks/post_gen_logic/__init__.py +13 -0
  51. nutri_matic-0.1.2/src/nutrimatic/hooks/post_gen_logic/ansible.py +36 -0
  52. nutri_matic-0.1.2/src/nutrimatic/hooks/post_gen_logic/docs.py +109 -0
  53. nutri_matic-0.1.2/src/nutrimatic/models/__init__.py +34 -0
  54. nutri_matic-0.1.2/src/nutrimatic/models/accounts.py +29 -0
  55. nutri_matic-0.1.2/src/nutrimatic/models/base.py +50 -0
  56. nutri_matic-0.1.2/src/nutrimatic/models/ccmeta.py +32 -0
  57. nutri_matic-0.1.2/src/nutrimatic/models/cctemplate.py +50 -0
  58. nutri_matic-0.1.2/src/nutrimatic/models/config.py +55 -0
  59. nutri_matic-0.1.2/src/nutrimatic/models/github.py +76 -0
  60. nutri_matic-0.1.2/src/nutrimatic/models/metadata.py +56 -0
  61. nutri_matic-0.1.2/src/nutrimatic/models/template.py +61 -0
  62. nutri_matic-0.1.2/src/nutrimatic/templates/__init__.py +15 -0
  63. nutri_matic-0.1.2/src/nutrimatic/templates/cc_templates.py +59 -0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 nutri-matic
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,276 @@
1
+ Metadata-Version: 2.4
2
+ Name: nutri-matic
3
+ Version: 0.1.2
4
+ Summary: Cookiecutter utilities for jcook3701's cookiecutter templates.
5
+ Author-email: Jared Cook <jcook3701+github@gmail.com>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/jcook3701/nutri-matic
8
+ Project-URL: Repository, https://github.com/jcook3701/nutri-matic
9
+ Project-URL: Documentation, https://github.com/jcook3701/nutri-matic/docs/jekyll
10
+ Keywords: python3,cookiecutter,templates,utilities
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Operating System :: OS Independent
13
+ Requires-Python: >=3.11
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Requires-Dist: cookiecutter>=2.6
17
+ Requires-Dist: Deprecated>=1.3
18
+ Requires-Dist: GitPython>=3.1
19
+ Requires-Dist: pydantic>=2.12
20
+ Requires-Dist: sphinx>=8.0
21
+ Requires-Dist: toml>=0.10
22
+ Requires-Dist: typer>=0.20
23
+ Requires-Dist: types-Deprecated>=1.3
24
+ Requires-Dist: types-requests>=2.32
25
+ Requires-Dist: types-PyYAML>=6.0
26
+ Requires-Dist: types-toml>=0.10
27
+ Provides-Extra: dev
28
+ Requires-Dist: build>=1.3; extra == "dev"
29
+ Requires-Dist: bump-my-version>=1.2; extra == "dev"
30
+ Requires-Dist: coverage>=7.12; extra == "dev"
31
+ Requires-Dist: black>=25.11; extra == "dev"
32
+ Requires-Dist: ruff>=0.14.0; extra == "dev"
33
+ Requires-Dist: mypy==1.9; extra == "dev"
34
+ Requires-Dist: myst-parser>=0.18; extra == "dev"
35
+ Requires-Dist: nameisok>=0.1; extra == "dev"
36
+ Requires-Dist: pytest>=8.0; extra == "dev"
37
+ Requires-Dist: pytest-cov>=7.0; extra == "dev"
38
+ Requires-Dist: yamllint>=1.0; extra == "dev"
39
+ Requires-Dist: twine>=6.2; extra == "dev"
40
+ Provides-Extra: docs
41
+ Requires-Dist: sphinx>=8.0; extra == "docs"
42
+ Requires-Dist: sphinx-rtd-theme>=3.0; extra == "docs"
43
+ Requires-Dist: sphinx-markdown-builder>=0.6; extra == "docs"
44
+ Requires-Dist: sphinx-autodoc-typehints>=3.5; extra == "docs"
45
+ Dynamic: license-file
46
+
47
+ <!--
48
+ Auto-generated file. Do not edit directly.
49
+ Edit /home/jcook/Documents/git_repo/nutri-matic/docs/jekyll/README.md instead.
50
+ Run ```make readme``` to regenerate this file
51
+ -->
52
+ <h1 id="nutri-matic">Nutri-Matic</h1>
53
+
54
+ <p><strong>Author:</strong> Jared Cook<br />
55
+ <strong>Version:</strong> 0.1.2</p>
56
+
57
+ <h2 id="overview">Overview</h2>
58
+ <p>Cookiecutter utilities for streamlining development and utilization of Cookiecutter templates.</p>
59
+
60
+ <hr />
61
+
62
+ <p><img src="https://github.com/jcook3701/nutri-matic/actions/workflows/black-format.yml/badge.svg" alt="black-format" />
63
+ <img src="https://github.com/jcook3701/nutri-matic/actions/workflows/ruff-lint.yml/badge.svg" alt="ruff-lint" />
64
+ <img src="https://github.com/jcook3701/nutri-matic/actions/workflows/tests.yml/badge.svg" alt="tests" />
65
+ <img src="https://github.com/jcook3701/nutri-matic/actions/workflows/typecheck.yml/badge.svg" alt="typecheck" />
66
+ <img src="https://github.com/jcook3701/nutri-matic/actions/workflows/yaml-lint.yml/badge.svg" alt="yaml-lint" /></p>
67
+
68
+ <h2 id="command-examples">Command Examples:</h2>
69
+ <h3 id="-nutrimatic-add_docs-extract-run-list">πŸ”§ nutrimatic (add_docs, extract, run, list)</h3>
70
+ <h4 id="add-docs">Add Docs:</h4>
71
+ <p><strong>Description:</strong> Add GitHub docs to an existing project using the github-docs-cookiecutter template.</p>
72
+ <ol>
73
+ <li>
74
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic add-docs <span class="si">$(</span>target_dir<span class="si">)</span>
75
+ </code></pre></div> </div>
76
+ </li>
77
+ </ol>
78
+
79
+ <h4 id="extract">Extract:</h4>
80
+ <p><strong>Description:</strong> Clone a repo, extract cookiecutter.json, remove Jinja placeholders, save locally.</p>
81
+ <ol>
82
+ <li>Run extract command to local cookiecutter repository:
83
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic extract ./python3-cookiecutter
84
+ </code></pre></div> </div>
85
+ <p><strong>OR</strong></p>
86
+ </li>
87
+ <li>Run extract command to remote github cookiecutter repository:
88
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic extract <span class="se">\</span>
89
+ <span class="nt">--repo</span> git@github.com:jcook3701/python3-cookiecutter.git <span class="se">\</span>
90
+ <span class="nt">--branch</span> develop <span class="se">\</span>
91
+ <span class="nt">--output</span> clean_cookiecutter.json
92
+ </code></pre></div> </div>
93
+ </li>
94
+ <li>Modify extracted json to meet you new projects requirements.</li>
95
+ </ol>
96
+
97
+ <h4 id="run">Run:</h4>
98
+ <p><strong>Description:</strong> Run a cookiecutter template using a pre-supplied JSON configuration file.</p>
99
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic run <span class="si">$(</span>template<span class="si">)</span> <span class="si">$(</span>config<span class="si">)</span>
100
+ </code></pre></div></div>
101
+
102
+ <h4 id="list">List:</h4>
103
+ <p><strong>Description:</strong> List available cookiecutter templates under a namespace.</p>
104
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic list
105
+ </code></pre></div></div>
106
+
107
+ <hr />
108
+
109
+ <h3 id="️-config-nm-config">βš™οΈ Config (nm-config)</h3>
110
+ <p><strong>Description:</strong> nutrimatic configuration tools.<br />
111
+ <strong>Note:</strong> These are tools that are used to manage package configuration file.</p>
112
+
113
+ <h4 id="sub-commands-show">Sub-commands: (show)</h4>
114
+
115
+ <h4 id="show">Show:</h4>
116
+ <p><strong>Description:</strong></p>
117
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nm-config show
118
+ </code></pre></div></div>
119
+
120
+ <hr />
121
+
122
+ <h3 id="-build-nm-build">πŸ”¨ Build (nm-build)</h3>
123
+ <p><strong>Description:</strong> Cookiecutter build automation utilities.<br />
124
+ <strong>Note:</strong> These commands are intended to be used within project Makefiles as build tools. Examples will assume for use in Makefile.</p>
125
+ <h4 id="sub-commands-readme-add-yaml-front-matter">Sub-commands: (readme, add-yaml-front-matter)</h4>
126
+
127
+ <h4 id="readme">Readme:</h4>
128
+ <p><strong>Description:</strong> Generates project readme from projects github-docs jekyll project. The intention is keep the readme within ./docs/jekyll as the projects single source of truth.<br />
129
+ <strong>Note</strong>: Replace with real values.</p>
130
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>PROJECT_ROOT :<span class="o">=</span> <span class="si">$(</span>PWD<span class="si">)</span>
131
+ DOCS_DIR :<span class="o">=</span> <span class="si">$(</span>PROJECT_ROOT<span class="si">)</span>/docs
132
+ JEKYLL_DIR :<span class="o">=</span> <span class="si">$(</span>DOCS_DIR<span class="si">)</span>/jekyll
133
+ JEKYLL_BUILD :<span class="o">=</span> bundle <span class="nb">exec </span>jekyll build <span class="nt">--quiet</span>
134
+ README_GEN_DIR :<span class="o">=</span> <span class="si">$(</span>JEKYLL_DIR<span class="si">)</span>/tmp_readme
135
+
136
+ readme:
137
+ nm-build readme <span class="si">$(</span>JEKYLL_DIR<span class="si">)</span> ./README.md <span class="se">\</span>
138
+ <span class="nt">--tmp-dir</span> <span class="si">$(</span>README_GEN_DIR<span class="si">)</span> <span class="nt">--jekyll-cmd</span> <span class="s1">'$(JEKYLL_BUILD)'</span>
139
+ </code></pre></div></div>
140
+
141
+ <h4 id="add-yaml-front-matter">add-yaml-front-matter:</h4>
142
+ <p><strong>Description:</strong> This adds yaml-front-matter to the head of (md, yml, &amp; yaml) files to help beautify github docs. Intended to be used with <a href="https://github.com/jcook3701/github-docs-cookiecutter">github-docs-cookiecutter</a></p>
143
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nm-build add-yaml-front-matter
144
+ </code></pre></div></div>
145
+
146
+ <hr />
147
+
148
+ <h2 id="-template-nm-templates">πŸͺ Template (nm-templates)</h2>
149
+ <p><strong>Description:</strong> nm-templates tools.
150
+ <strong>Note:</strong> github-docs-cookiecutter will either be moved to <a href="https://github.com/jcook3701/cc-templates">cc-templates</a> or be added to cc-templates as a submodule. #### Sub-commands: (generate)</p>
151
+
152
+ <h4 id="generate">Generate:</h4>
153
+ <p><strong>Description:</strong> This is for custom Cookiecutter template (<a href="https://github.com/jcook3701/cc-templates">cc-templates</a>) that utilizes ccmeta.toml files to organize projects.<br />
154
+ <strong>Note:</strong> This feature is still in development. <strong>(Use at your own risk!!!)</strong><br />
155
+ <strong>Arguments:</strong></p>
156
+ <ul>
157
+ <li>repo: Path to the template repository to generate README.md and Makefile
158
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nm-templates generate <span class="si">$(</span>repo<span class="si">)</span>
159
+ </code></pre></div> </div>
160
+ </li>
161
+ </ul>
162
+
163
+ <hr />
164
+
165
+ <h2 id="development-strategy">Development Strategy</h2>
166
+ <p><strong>Note:</strong> All Makefile commands are used in ci/cd to ensure that if they pass locally they should also pass once pushed to github.</p>
167
+ <h3 id="️-build-environment-venv">🐍️ Build environment (.venv)</h3>
168
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">install</span>
169
+ </code></pre></div></div>
170
+ <h3 id="-linting-ruff--yaml-lint">πŸ” Linting (ruff &amp; yaml-lint)</h3>
171
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make lint-check
172
+ </code></pre></div></div>
173
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make lint-fix
174
+ </code></pre></div></div>
175
+ <h3 id="-formatting-black">🎨 Formatting (black)</h3>
176
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make format-check
177
+ </code></pre></div></div>
178
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make format-fix
179
+ </code></pre></div></div>
180
+ <h3 id="-typechecking-mypy">🧠 Typechecking (mypy)</h3>
181
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make typecheck
182
+ </code></pre></div></div>
183
+ <h3 id="-testing-pytest">πŸ§ͺ Testing (pytest)</h3>
184
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">test</span>
185
+ </code></pre></div></div>
186
+ <h3 id="-version-bumping-bumpy-my-version">πŸ”– Version Bumping (bumpy-my-version)</h3>
187
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make bump-version-patch
188
+ </code></pre></div></div>
189
+ <h3 id="-building-build">πŸ“¦ Building (build)</h3>
190
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make build
191
+ </code></pre></div></div>
192
+ <h3 id="-publishing-twine">πŸš€ Publishing (Twine)</h3>
193
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make pubish
194
+ </code></pre></div></div>
195
+ <h3 id="build-help">Build Help</h3>
196
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">help</span>
197
+ </code></pre></div></div>
198
+
199
+ <hr />
200
+
201
+ <h2 id="authors-notes">🍹Authors Notes:</h2>
202
+ <p>Their fundamental design flaws are completely hidden by their superficial design flaws.</p>
203
+
204
+ <h3 id="todos">TODO’s:</h3>
205
+ <ol>
206
+ <li>cc-templates/ccindex.toml
207
+ <ul>
208
+ <li>create/update this file using the individual ccmeta.toml files in cc-templates</li>
209
+ </ul>
210
+ </li>
211
+ <li>Finish updating this.readme with command usage.</li>
212
+ <li>Readme <code class="language-plaintext highlighter-rouge">make readme</code> should end up being a ci/cd process to ensure it is always up to date.</li>
213
+ <li>Thinking about adding a ci/cd process for version bumping. To create a git tag.</li>
214
+ </ol>
215
+
216
+ <h3 id="future-design-decisions">Future Design Decisions:</h3>
217
+ <ol>
218
+ <li>I need to decide whether to change all my current Cookiecutter projects to use the prefix <code class="language-plaintext highlighter-rouge">cc-</code> and use them as submodules within the <a href="https://github.com/jcook3701/cc-templates">cc-templates</a> repository. Or to just move the code directly into the cc-templates repository and use it as a monolithic repo.</li>
219
+ </ol>
220
+
221
+ <!--
222
+
223
+ 2. Need to come up with a new name as ccutils and cc-utils are giving me issues on either pypi or testpypi.
224
+ * Thinking of going with Hitch Hikers Guide to Galaxy based names as this is becoming rediculious.
225
+
226
+
227
+ πŸ§£πŸ“–πŸ€–πŸ§‘β€πŸš€πŸ‘½βœ¨πŸš€πŸ›ΈπŸͺπŸΉπŸ§ƒ
228
+
229
+ cc-utils -> slartibartfast, improbability_drive, probability_engine, hyperjumps
230
+ cc-templates -> ~~Magrathea~~, restaurant_at_end_of_universe, life_universe_everything
231
+
232
+ slartibartfast -> src -> fjord
233
+ slartibartfast -> Magrathea
234
+
235
+ SubEtha -> Messaging system. Good Open Name. (should claim)
236
+
237
+ To replace cc-utils:
238
+ 1. βœ… HeartOfGold
239
+ 2. βœ… heart_of_gold, (claim)
240
+ 3. ❌ ImprobCore
241
+ 4. βœ… improbability_core (claim)
242
+ 5. βœ… improb_core
243
+ 6. βœ… robot_marvin
244
+ To replace cc-templates:
245
+ 1. ❌ NutriMatic
246
+ 2. βœ… nutri_matic (claim)
247
+
248
+ __Notes:__
249
+ ##### Project Theme (Hitch Hikers Guide the Galaxy)
250
+ "Don't Panic."
251
+ "The ships hung in the sky in much the same way that bricks don't."
252
+ "The answer to the great question...of Life, the Universe and Everything...is...forty-two."
253
+ "For a moment, nothing happened. Then, after a second or so, nothing continued to happen."
254
+ "I may not have gone where I intended to go, but I think I have ended up where I needed to be".
255
+ "The story so far: In the beginning the Universe was created. This has made a lot of people very angry and been widely regarded as a bad move".
256
+
257
+ ##### Heart of Gold (cc-utils)
258
+ 1. β€œHi there! This is Eddie, your shipboard computer, and I’m feeling just great, guys, and I know I’m just going to get a bundle of kicks out of any program you care to run through me.”
259
+
260
+ 2. β€œThat ship?” said Ford in sudden excitement. β€œWhat happened to it? Do you know?” β€œIt hated me because I talked to it.” β€œYou talked to it?” exclaimed Ford. β€œWhat do you mean you talked to it?” β€œSimple. I got very bored and depressed, so I went and plugged myself in to its external computer feed. I talked to the computer at great length and explained my view of the Universe to it,” said Marvin. β€œAnd what happened?” pressed Ford. β€œIt committed suicide,” said Marvin, and stalked off back to the Heart of Gold.
261
+
262
+ ##### Nuri-Matic (cc-utils)
263
+ β€œThe Nutri-Matic Drinks Synthesizer claimed to produce the widest possible range of drinks personally matched to the tastes and metabolism of whoever cared to use it. When put to test, however, it invariably produced a plastic cup filled with a liquid which was almost, but not quite, entirely unlike tea.”
264
+
265
+
266
+ cc-python-cli
267
+ cc-ansible-role
268
+ cc-sphinx-docs
269
+ cc-github-docs
270
+ -->
271
+
272
+ <h2 id="package">Package:</h2>
273
+ <h3 id="pypi-stable">PyPi: (stable)</h3>
274
+ <p>https://pypi.org/project/nutri-matic/</p>
275
+ <h3 id="testpypi-development">TestPyPi: (development)</h3>
276
+ <p>https://test.pypi.org/project/nutri-matic/</p>
@@ -0,0 +1,230 @@
1
+ <!--
2
+ Auto-generated file. Do not edit directly.
3
+ Edit /home/jcook/Documents/git_repo/nutri-matic/docs/jekyll/README.md instead.
4
+ Run ```make readme``` to regenerate this file
5
+ -->
6
+ <h1 id="nutri-matic">Nutri-Matic</h1>
7
+
8
+ <p><strong>Author:</strong> Jared Cook<br />
9
+ <strong>Version:</strong> 0.1.2</p>
10
+
11
+ <h2 id="overview">Overview</h2>
12
+ <p>Cookiecutter utilities for streamlining development and utilization of Cookiecutter templates.</p>
13
+
14
+ <hr />
15
+
16
+ <p><img src="https://github.com/jcook3701/nutri-matic/actions/workflows/black-format.yml/badge.svg" alt="black-format" />
17
+ <img src="https://github.com/jcook3701/nutri-matic/actions/workflows/ruff-lint.yml/badge.svg" alt="ruff-lint" />
18
+ <img src="https://github.com/jcook3701/nutri-matic/actions/workflows/tests.yml/badge.svg" alt="tests" />
19
+ <img src="https://github.com/jcook3701/nutri-matic/actions/workflows/typecheck.yml/badge.svg" alt="typecheck" />
20
+ <img src="https://github.com/jcook3701/nutri-matic/actions/workflows/yaml-lint.yml/badge.svg" alt="yaml-lint" /></p>
21
+
22
+ <h2 id="command-examples">Command Examples:</h2>
23
+ <h3 id="-nutrimatic-add_docs-extract-run-list">πŸ”§ nutrimatic (add_docs, extract, run, list)</h3>
24
+ <h4 id="add-docs">Add Docs:</h4>
25
+ <p><strong>Description:</strong> Add GitHub docs to an existing project using the github-docs-cookiecutter template.</p>
26
+ <ol>
27
+ <li>
28
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic add-docs <span class="si">$(</span>target_dir<span class="si">)</span>
29
+ </code></pre></div> </div>
30
+ </li>
31
+ </ol>
32
+
33
+ <h4 id="extract">Extract:</h4>
34
+ <p><strong>Description:</strong> Clone a repo, extract cookiecutter.json, remove Jinja placeholders, save locally.</p>
35
+ <ol>
36
+ <li>Run extract command to local cookiecutter repository:
37
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic extract ./python3-cookiecutter
38
+ </code></pre></div> </div>
39
+ <p><strong>OR</strong></p>
40
+ </li>
41
+ <li>Run extract command to remote github cookiecutter repository:
42
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic extract <span class="se">\</span>
43
+ <span class="nt">--repo</span> git@github.com:jcook3701/python3-cookiecutter.git <span class="se">\</span>
44
+ <span class="nt">--branch</span> develop <span class="se">\</span>
45
+ <span class="nt">--output</span> clean_cookiecutter.json
46
+ </code></pre></div> </div>
47
+ </li>
48
+ <li>Modify extracted json to meet you new projects requirements.</li>
49
+ </ol>
50
+
51
+ <h4 id="run">Run:</h4>
52
+ <p><strong>Description:</strong> Run a cookiecutter template using a pre-supplied JSON configuration file.</p>
53
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic run <span class="si">$(</span>template<span class="si">)</span> <span class="si">$(</span>config<span class="si">)</span>
54
+ </code></pre></div></div>
55
+
56
+ <h4 id="list">List:</h4>
57
+ <p><strong>Description:</strong> List available cookiecutter templates under a namespace.</p>
58
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nutrimatic list
59
+ </code></pre></div></div>
60
+
61
+ <hr />
62
+
63
+ <h3 id="️-config-nm-config">βš™οΈ Config (nm-config)</h3>
64
+ <p><strong>Description:</strong> nutrimatic configuration tools.<br />
65
+ <strong>Note:</strong> These are tools that are used to manage package configuration file.</p>
66
+
67
+ <h4 id="sub-commands-show">Sub-commands: (show)</h4>
68
+
69
+ <h4 id="show">Show:</h4>
70
+ <p><strong>Description:</strong></p>
71
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nm-config show
72
+ </code></pre></div></div>
73
+
74
+ <hr />
75
+
76
+ <h3 id="-build-nm-build">πŸ”¨ Build (nm-build)</h3>
77
+ <p><strong>Description:</strong> Cookiecutter build automation utilities.<br />
78
+ <strong>Note:</strong> These commands are intended to be used within project Makefiles as build tools. Examples will assume for use in Makefile.</p>
79
+ <h4 id="sub-commands-readme-add-yaml-front-matter">Sub-commands: (readme, add-yaml-front-matter)</h4>
80
+
81
+ <h4 id="readme">Readme:</h4>
82
+ <p><strong>Description:</strong> Generates project readme from projects github-docs jekyll project. The intention is keep the readme within ./docs/jekyll as the projects single source of truth.<br />
83
+ <strong>Note</strong>: Replace with real values.</p>
84
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>PROJECT_ROOT :<span class="o">=</span> <span class="si">$(</span>PWD<span class="si">)</span>
85
+ DOCS_DIR :<span class="o">=</span> <span class="si">$(</span>PROJECT_ROOT<span class="si">)</span>/docs
86
+ JEKYLL_DIR :<span class="o">=</span> <span class="si">$(</span>DOCS_DIR<span class="si">)</span>/jekyll
87
+ JEKYLL_BUILD :<span class="o">=</span> bundle <span class="nb">exec </span>jekyll build <span class="nt">--quiet</span>
88
+ README_GEN_DIR :<span class="o">=</span> <span class="si">$(</span>JEKYLL_DIR<span class="si">)</span>/tmp_readme
89
+
90
+ readme:
91
+ nm-build readme <span class="si">$(</span>JEKYLL_DIR<span class="si">)</span> ./README.md <span class="se">\</span>
92
+ <span class="nt">--tmp-dir</span> <span class="si">$(</span>README_GEN_DIR<span class="si">)</span> <span class="nt">--jekyll-cmd</span> <span class="s1">'$(JEKYLL_BUILD)'</span>
93
+ </code></pre></div></div>
94
+
95
+ <h4 id="add-yaml-front-matter">add-yaml-front-matter:</h4>
96
+ <p><strong>Description:</strong> This adds yaml-front-matter to the head of (md, yml, &amp; yaml) files to help beautify github docs. Intended to be used with <a href="https://github.com/jcook3701/github-docs-cookiecutter">github-docs-cookiecutter</a></p>
97
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nm-build add-yaml-front-matter
98
+ </code></pre></div></div>
99
+
100
+ <hr />
101
+
102
+ <h2 id="-template-nm-templates">πŸͺ Template (nm-templates)</h2>
103
+ <p><strong>Description:</strong> nm-templates tools.
104
+ <strong>Note:</strong> github-docs-cookiecutter will either be moved to <a href="https://github.com/jcook3701/cc-templates">cc-templates</a> or be added to cc-templates as a submodule. #### Sub-commands: (generate)</p>
105
+
106
+ <h4 id="generate">Generate:</h4>
107
+ <p><strong>Description:</strong> This is for custom Cookiecutter template (<a href="https://github.com/jcook3701/cc-templates">cc-templates</a>) that utilizes ccmeta.toml files to organize projects.<br />
108
+ <strong>Note:</strong> This feature is still in development. <strong>(Use at your own risk!!!)</strong><br />
109
+ <strong>Arguments:</strong></p>
110
+ <ul>
111
+ <li>repo: Path to the template repository to generate README.md and Makefile
112
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>nm-templates generate <span class="si">$(</span>repo<span class="si">)</span>
113
+ </code></pre></div> </div>
114
+ </li>
115
+ </ul>
116
+
117
+ <hr />
118
+
119
+ <h2 id="development-strategy">Development Strategy</h2>
120
+ <p><strong>Note:</strong> All Makefile commands are used in ci/cd to ensure that if they pass locally they should also pass once pushed to github.</p>
121
+ <h3 id="️-build-environment-venv">🐍️ Build environment (.venv)</h3>
122
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">install</span>
123
+ </code></pre></div></div>
124
+ <h3 id="-linting-ruff--yaml-lint">πŸ” Linting (ruff &amp; yaml-lint)</h3>
125
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make lint-check
126
+ </code></pre></div></div>
127
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make lint-fix
128
+ </code></pre></div></div>
129
+ <h3 id="-formatting-black">🎨 Formatting (black)</h3>
130
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make format-check
131
+ </code></pre></div></div>
132
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make format-fix
133
+ </code></pre></div></div>
134
+ <h3 id="-typechecking-mypy">🧠 Typechecking (mypy)</h3>
135
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make typecheck
136
+ </code></pre></div></div>
137
+ <h3 id="-testing-pytest">πŸ§ͺ Testing (pytest)</h3>
138
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">test</span>
139
+ </code></pre></div></div>
140
+ <h3 id="-version-bumping-bumpy-my-version">πŸ”– Version Bumping (bumpy-my-version)</h3>
141
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make bump-version-patch
142
+ </code></pre></div></div>
143
+ <h3 id="-building-build">πŸ“¦ Building (build)</h3>
144
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make build
145
+ </code></pre></div></div>
146
+ <h3 id="-publishing-twine">πŸš€ Publishing (Twine)</h3>
147
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make pubish
148
+ </code></pre></div></div>
149
+ <h3 id="build-help">Build Help</h3>
150
+ <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>make <span class="nb">help</span>
151
+ </code></pre></div></div>
152
+
153
+ <hr />
154
+
155
+ <h2 id="authors-notes">🍹Authors Notes:</h2>
156
+ <p>Their fundamental design flaws are completely hidden by their superficial design flaws.</p>
157
+
158
+ <h3 id="todos">TODO’s:</h3>
159
+ <ol>
160
+ <li>cc-templates/ccindex.toml
161
+ <ul>
162
+ <li>create/update this file using the individual ccmeta.toml files in cc-templates</li>
163
+ </ul>
164
+ </li>
165
+ <li>Finish updating this.readme with command usage.</li>
166
+ <li>Readme <code class="language-plaintext highlighter-rouge">make readme</code> should end up being a ci/cd process to ensure it is always up to date.</li>
167
+ <li>Thinking about adding a ci/cd process for version bumping. To create a git tag.</li>
168
+ </ol>
169
+
170
+ <h3 id="future-design-decisions">Future Design Decisions:</h3>
171
+ <ol>
172
+ <li>I need to decide whether to change all my current Cookiecutter projects to use the prefix <code class="language-plaintext highlighter-rouge">cc-</code> and use them as submodules within the <a href="https://github.com/jcook3701/cc-templates">cc-templates</a> repository. Or to just move the code directly into the cc-templates repository and use it as a monolithic repo.</li>
173
+ </ol>
174
+
175
+ <!--
176
+
177
+ 2. Need to come up with a new name as ccutils and cc-utils are giving me issues on either pypi or testpypi.
178
+ * Thinking of going with Hitch Hikers Guide to Galaxy based names as this is becoming rediculious.
179
+
180
+
181
+ πŸ§£πŸ“–πŸ€–πŸ§‘β€πŸš€πŸ‘½βœ¨πŸš€πŸ›ΈπŸͺπŸΉπŸ§ƒ
182
+
183
+ cc-utils -> slartibartfast, improbability_drive, probability_engine, hyperjumps
184
+ cc-templates -> ~~Magrathea~~, restaurant_at_end_of_universe, life_universe_everything
185
+
186
+ slartibartfast -> src -> fjord
187
+ slartibartfast -> Magrathea
188
+
189
+ SubEtha -> Messaging system. Good Open Name. (should claim)
190
+
191
+ To replace cc-utils:
192
+ 1. βœ… HeartOfGold
193
+ 2. βœ… heart_of_gold, (claim)
194
+ 3. ❌ ImprobCore
195
+ 4. βœ… improbability_core (claim)
196
+ 5. βœ… improb_core
197
+ 6. βœ… robot_marvin
198
+ To replace cc-templates:
199
+ 1. ❌ NutriMatic
200
+ 2. βœ… nutri_matic (claim)
201
+
202
+ __Notes:__
203
+ ##### Project Theme (Hitch Hikers Guide the Galaxy)
204
+ "Don't Panic."
205
+ "The ships hung in the sky in much the same way that bricks don't."
206
+ "The answer to the great question...of Life, the Universe and Everything...is...forty-two."
207
+ "For a moment, nothing happened. Then, after a second or so, nothing continued to happen."
208
+ "I may not have gone where I intended to go, but I think I have ended up where I needed to be".
209
+ "The story so far: In the beginning the Universe was created. This has made a lot of people very angry and been widely regarded as a bad move".
210
+
211
+ ##### Heart of Gold (cc-utils)
212
+ 1. β€œHi there! This is Eddie, your shipboard computer, and I’m feeling just great, guys, and I know I’m just going to get a bundle of kicks out of any program you care to run through me.”
213
+
214
+ 2. β€œThat ship?” said Ford in sudden excitement. β€œWhat happened to it? Do you know?” β€œIt hated me because I talked to it.” β€œYou talked to it?” exclaimed Ford. β€œWhat do you mean you talked to it?” β€œSimple. I got very bored and depressed, so I went and plugged myself in to its external computer feed. I talked to the computer at great length and explained my view of the Universe to it,” said Marvin. β€œAnd what happened?” pressed Ford. β€œIt committed suicide,” said Marvin, and stalked off back to the Heart of Gold.
215
+
216
+ ##### Nuri-Matic (cc-utils)
217
+ β€œThe Nutri-Matic Drinks Synthesizer claimed to produce the widest possible range of drinks personally matched to the tastes and metabolism of whoever cared to use it. When put to test, however, it invariably produced a plastic cup filled with a liquid which was almost, but not quite, entirely unlike tea.”
218
+
219
+
220
+ cc-python-cli
221
+ cc-ansible-role
222
+ cc-sphinx-docs
223
+ cc-github-docs
224
+ -->
225
+
226
+ <h2 id="package">Package:</h2>
227
+ <h3 id="pypi-stable">PyPi: (stable)</h3>
228
+ <p>https://pypi.org/project/nutri-matic/</p>
229
+ <h3 id="testpypi-development">TestPyPi: (development)</h3>
230
+ <p>https://test.pypi.org/project/nutri-matic/</p>