/
moo.html
660 lines (593 loc) · 23.1 KB
/
moo.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2022-09-15 Thu 11:41 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>moo 無 Model Oriented Objects</title>
<meta name="generator" content="Org mode" />
<meta name="author" content="Brett Viren" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: auto;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline; margin-top: 14px;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<link rel="stylesheet" type="text/css" href="https://brettviren.github.io/moo/other/readtheorg/css/htmlize.css"/>
<link rel="stylesheet" type="text/css" href="https://brettviren.github.io/moo/other/readtheorg/css/readtheorg.css"/>
<script type="text/javascript" src="https://brettviren.github.io/moo/other/lib/js/jquery.min.js"></script>
<script type="text/javascript" src="https://brettviren.github.io/moo/other/lib/js/bootstrap.min.js"></script>
<script type="text/javascript" src="https://brettviren.github.io/moo/other/lib/js/jquery.stickytableheaders.min.js"></script>
<script type="text/javascript" src="https://brettviren.github.io/moo/other/readtheorg/js/readtheorg.js"></script>
<style> #content{max-width:1800px;}</style>
<style> p{max-width:800px;}</style>
<style> li{max-width:800px;}</style>
<style> pre.src{border-radius: 5px; background-color:#333; color:#0f0;}</style>
<style> pre.example{border-radius: 5px; background-color:#333; color:#0f0;}</style>
<style> code{border-radius: 5px; background-color:#333; color:#0f0;}</style>
<script type="text/javascript">
// @license magnet:?xt=urn:btih:1f739d935676111cfff4b4693e3816e664797050&dn=gpl-3.0.txt GPL-v3-or-Later
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.classList.add("code-highlighted");
target.classList.add("code-highlighted");
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.classList.remove("code-highlighted");
target.classList.remove("code-highlighted");
}
}
/*]]>*///-->
// @license-end
</script>
</head>
<body>
<div id="content">
<h1 class="title">moo 無 Model Oriented Objects</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#overview">Overview</a>
<ul>
<li><a href="#org67b9f1c">Taxonomy</a></li>
<li><a href="#orgd90a19c">Operations</a></li>
<li><a href="#orga138782">Uses</a></li>
</ul>
</li>
<li><a href="#version">Version</a></li>
<li><a href="#org845298b">License</a></li>
<li><a href="#install">Installation</a>
<ul>
<li><a href="#python-env">Python environment</a></li>
<li><a href="#install-rel">Install a release</a></li>
<li><a href="#install-dev">Install development</a></li>
<li><a href="#orgeb08147">Testing</a></li>
</ul>
</li>
<li><a href="#punt">Quick start</a></li>
<li><a href="#docs">Documentation</a>
<ul>
<li><a href="#links">Links</a></li>
</ul>
</li>
<li><a href="#releases">Releases</a>
<ul>
<li><a href="#releasing">Releasing</a></li>
</ul>
</li>
<li><a href="#etc">Etc</a></li>
</ul>
</div>
</div>
<div id="outline-container-overview" class="outline-2">
<h2 id="overview">Overview</h2>
<div class="outline-text-2" id="text-overview">
<p>
<b>moo</b> is a tool for schema driven code generation.
</p>
</div>
<div id="outline-container-org67b9f1c" class="outline-3">
<h3 id="org67b9f1c">Taxonomy</h3>
<div class="outline-text-3" id="text-org67b9f1c">
<p>
<b>moo</b> defines a conceptual taxonmy
</p>
<dl class="org-dl">
<dt>schema</dt><dd>a data structure describing the structure of data (including schema).</dd>
<dt>model</dt><dd>a data structure which is valid against a schema</dd>
<dt>template</dt><dd>text in some target format which is marked up with directives that are parameterized in terms of a schema and provided by a valid model</dd>
<dt>codegen</dt><dd>an artifact generated by applying a model to a template each adhering to a schema.</dd>
</dl>
</div>
</div>
<div id="outline-container-orgd90a19c" class="outline-3">
<h3 id="orgd90a19c">Operations</h3>
<div class="outline-text-3" id="text-orgd90a19c">
<p>
<b>moo</b> may operate on instances of the <b>moo</b> taxonomy in various ways
</p>
<dl class="org-dl">
<dt>compile</dt><dd>transform a model or a schema from one representation to another</dd>
<dt>imports</dt><dd>calculate an implicit file dependencies in the file representation of a model, schema or template</dd>
<dt>validate</dt><dd>determine if a model adheres to a schema</dd>
<dt>render</dt><dd>generate code (or other forms) by applying a model to a template</dd>
</dl>
</div>
</div>
<div id="outline-container-orga138782" class="outline-3">
<h3 id="orga138782">Uses</h3>
<div class="outline-text-3" id="text-orga138782">
<p>
<b>moo</b> can be used for many things
</p>
<ul class="org-ul">
<li>define a unified data model with generated types in multiple languages</li>
<li>produce serialization methods for objects in a data model</li>
<li>translate from <b>moo</b> schema to others such as Avro, Protobuf, JSON Schema</li>
<li>generate "perfect" instances of complex code <b>patterns</b> such as finite state machines from simple models</li>
<li>…and more</li>
</ul>
</div>
</div>
</div>
<div id="outline-container-version" class="outline-2">
<h2 id="version">Version</h2>
<div class="outline-text-2" id="text-version">
<p>
The current <b>moo</b> version is…
</p>
<pre class="example" id="org6771cb3">
0.6.1
</pre>
<p>
…as of last time this file was updated. See <code>moo/version.py</code> for the
definitive version.
</p>
</div>
</div>
<div id="outline-container-org845298b" class="outline-2">
<h2 id="org845298b">License</h2>
<div class="outline-text-2" id="text-org845298b">
<p>
<b>moo</b> is free software and may be used under the terms described in file
<a href="COPYING">COPYING</a>. These terms explicitly do NOT extend to any of your own
files which may be input to or output from <b>moo</b> software.
</p>
</div>
</div>
<div id="outline-container-install" class="outline-2">
<h2 id="install">Installation</h2>
<div class="outline-text-2" id="text-install">
<p>
<b>moo</b> requires Python 3.5 or newer.
</p>
<p>
<b>moo</b> installs in to your favorite Python environment in most of the
usual ways. Some examples are given below. Due to a name conflict
(this) <b>moo</b> is currently not distributed through PyPI.
</p>
</div>
<div id="outline-container-python-env" class="outline-3">
<h3 id="python-env">Python environment</h3>
<div class="outline-text-3" id="text-python-env">
<p>
Here, <code>python</code> is assumed to be Python 3. Use whatever your favorite
Python environment is to assure that. Some suggestions:
</p>
</div>
<div id="outline-container-org2f97de2" class="outline-4">
<h4 id="org2f97de2">Python3 built in virtual environment</h4>
<div class="outline-text-4" id="text-org2f97de2">
<pre class="example" id="org771cfb3">
$ python3 -m venv venv
$ source venv/bin/activiate
</pre>
</div>
</div>
<div id="outline-container-orgffd1410" class="outline-4">
<h4 id="orgffd1410">Direnv</h4>
<div class="outline-text-4" id="text-orgffd1410">
<p>
Install <code>direnv</code> and activate it in your shell, then:
</p>
<pre class="example" id="orgddba0c2">
$ echo "layout python3" > .envrc
$ direnv allow
</pre>
<p>
See more at <a href="https://github.com/direnv/direnv">https://github.com/direnv/direnv</a>
</p>
</div>
</div>
</div>
<div id="outline-container-install-rel" class="outline-3">
<h3 id="install-rel">Install a release</h3>
<div class="outline-text-3" id="text-install-rel">
<p>
Via a release tarball:
</p>
<pre class="example" id="orge189a74">
$ python -m pip install https://github.com/brettviren/moo/archive/0.4.1.tar.gz
</pre>
<p>
Or, via git:
</p>
<pre class="example" id="org213e08d">
$ python -m pip install git+git://github.com/brettviren/moo.git@0.4.1#egg=moo
</pre>
</div>
</div>
<div id="outline-container-install-dev" class="outline-3">
<h3 id="install-dev">Install development</h3>
<div class="outline-text-3" id="text-install-dev">
<p>
Just install:
</p>
<pre class="example" id="org783f8f1">
$ python -m pip install git+git://github.com/brettviren/moo.git#egg=moo
</pre>
<p>
Or, maybe you want to hack on the code:
</p>
<pre class="example" id="orga9dfec5">
$ git clone git@github.com:brettviren/moo.git
$ cd moo
$ pyton -m pip install -e .
</pre>
</div>
</div>
<div id="outline-container-orgeb08147" class="outline-3">
<h3 id="orgeb08147">Testing</h3>
<div class="outline-text-3" id="text-orgeb08147">
<p>
<b>moo</b> source provides many types of tests. Below shows how to run the
different types of tests and their output from last time this document
was regenerated. Besides these explicit examples, regenerating <b>moo</b>
documents runs various tests which are embedded as examples.
</p>
</div>
<div id="outline-container-org13b7787" class="outline-4">
<h4 id="org13b7787">Shell level tests</h4>
<div class="outline-text-4" id="text-org13b7787">
<p>
The shell-level tests require BATS and <a href="https://github.com/bats-core/bats-core/">bats-core</a> is the recommended
implementation.
</p>
<div class="org-src-container">
<pre class="src src-shell">bats -j 8 test
</pre>
</div>
<pre class="example" id="org477f078">
</pre>
</div>
</div>
<div id="outline-container-orgb326832" class="outline-4">
<h4 id="orgb326832">Python level tests</h4>
<div class="outline-text-4" id="text-orgb326832">
<p>
The Python-level tests require pytest. Note, developers should not
disable warnings when running tests. For the sake of brevity in this
document they are turned off as some 3rd party packages trigger noisy
but currently innocuous deprecation warnings.
</p>
<div class="org-src-container">
<pre class="src src-shell">pytest --disable-warnings
</pre>
</div>
<pre class="example" id="org4ca4ff2">
============================= test session starts ==============================
platform linux -- Python 3.9.2, pytest-7.1.3, pluggy-1.0.0
rootdir: /home/bv/dev/moo
collected 25 items
test/test_issue11.py . [ 4%]
test/test_issue13.py .... [ 20%]
test/test_issue16.py .. [ 28%]
test/test_issue27.py ... [ 40%]
test/test_issue38.py . [ 44%]
test/test_moo_ogen.py . [ 48%]
test/test_moo_otypes.py ..... [ 68%]
test/test_moo_templates.py .. [ 76%]
test/test_moo_util.py .... [ 92%]
test/test_ogen_schema.py . [ 96%]
test/test_validate.py . [100%]
============================== 25 passed in 0.94s ==============================
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-punt" class="outline-2">
<h2 id="punt">Quick start</h2>
<div class="outline-text-2" id="text-punt">
<p>
The <b>moo</b> command line interface provides various commands and online
help:
</p>
<pre class="example" id="org731f44b">
$ moo --help
</pre>
<p>
See links below for documentation which provides various examples.
</p>
</div>
</div>
<div id="outline-container-docs" class="outline-2">
<h2 id="docs">Documentation</h2>
<div class="outline-text-2" id="text-docs">
</div>
<div id="outline-container-links" class="outline-3">
<h3 id="links">Links</h3>
<div class="outline-text-3" id="text-links">
<dl class="org-dl">
<dt>home page</dt><dd><a href="https://brettviren.github.io/moo">https://brettviren.github.io/moo</a></dd>
<dt>code repo</dt><dd><a href="https://github.com/brettviren/moo">https://github.com/brettviren/moo</a></dd>
<dt>documentation</dt><dd><ul class="org-ul">
<li><a href="moo.html">moo high level documentation</a> (this file)</li>
<li><a href="oschema.html">moo object schema paradigm</a> how to define <b>schema</b> and use it to validate models, apply <b>models</b> to <b>templates</b> for example to implement <b>codegen</b></li>
<li><a href="otypes.html">moo object types</a> way to <b>create objects</b> with a valid-by-construction pattern in <b>Python</b></li>
<li><a href="ovalid.html">moo object validation</a> to strongly check if existing objects are <b>valid against moo schema</b>.</li>
<li><a href="buildsys.html">moo and build systems</a> how to integrate <b>moo</b> codegen into various <b>build systems</b></li>
<li><a href="tla.html">moo and top-level arguments</a> flexible way to <b>inject values</b> into a Jsonnet program</li>
<li><a href="wcup.html">moo as Wire-Cell user package generator</a> how <b>moo</b> can be used to generate a skeleton of an entire software project</li>
<li><a href="reqs.html">moo for LaTeX and spreadsheet generator</a> using <b>moo</b> in production of documentation</li>
</ul></dd>
</dl>
</div>
</div>
</div>
<div id="outline-container-releases" class="outline-2">
<h2 id="releases">Releases</h2>
<div class="outline-text-2" id="text-releases">
<p>
While <code>moo</code> has a <code>0.y.z</code> release, backward compatibility is not a strong
priority as all uses are also in flux. <code>y</code> will increment with major
new features which may or may not be backward compatible. <code>z</code> will
increment with minor bug fixes.
</p>
</div>
<div id="outline-container-releasing" class="outline-3">
<h3 id="releasing">Releasing</h3>
<div class="outline-text-3" id="text-releasing">
<p>
Notes to self on making a release:
</p>
<ul class="org-ul">
<li>edit <a href="moo/version.py">moo/version.py</a> to set release version</li>
<li>reexport this and other documentation files, no cache and check for failures
<ul class="org-ul">
<li>bats/pytest runs as part of exporting this file</li>
</ul></li>
<li><code>git commit</code> and <code>git tag -am 'Pithy release message' X.Y.Z</code> using matching string</li>
<li>edit <a href="moo/version.py">moo/version.py</a> to go back to a dev version</li>
<li><code>git commit</code> and <code>git push</code> and <code>git push --tags</code></li>
<li>visit github release page and add any useful details</li>
</ul>
</div>
</div>
</div>
<div id="outline-container-etc" class="outline-2">
<h2 id="etc">Etc</h2>
<div class="outline-text-2" id="text-etc">
<p>
The name <b>moo</b> is a play on the Japanese term 無 which may be
interpreted to English in a few ways. Some are listed below along
with how the meaning reflects on aspects of <b>moo</b>.
</p>
<dl class="org-dl">
<dt>Untainted pure mind</dt><dd><b>moo</b> avoids being "opinionated", is centered
on ideas expressed as abstract data structures and so can be used
for a wide variety of things from generating code, documents or
package skeletons. <b>moo</b> forms its data structures by ingesting most
of the popular file formats likely to be used. And, <b>moo</b> can produce
any file format for which a user may create a template.</dd>
<dt>No strings attached</dt><dd><b>moo</b> is not intended to be an invasive tool.
<b>moo</b> artifacts can be generated as desired and <b>moo</b> may be left
behind. <b>moo</b> does not lock-in particular formats. <b>moo</b> extends this
freedom to your own applications. By adopting <b>moo</b> codegen
philosophy an app need not lock-in itself to particular data
formats, representations, or serializations technologies.</dd>
<dt>Nothingness</dt><dd><b>moo</b> is not really anything itself but rather it is
the bits that go between other real things which perform the "heavy
lifting" (Jsonnet, anyconfig, Jinja, JSON Schema, user templates).
<b>moo</b> lets apps embrace the power of this nothingness by switching
developer effort away from repetitive programming tasks and toward
data structure and template development and then through code
generation that effort gains multiplicative power.</dd>
</dl>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Brett Viren</p>
<p class="date">Created: 2022-09-15 Thu 11:41</p>
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>