-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathREADME.html
365 lines (253 loc) · 19.1 KB
/
README.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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Overview — lookml-tools 1.0.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="LookML Linter" href="README_LINTER.html" />
<link rel="prev" title="Welcome to lookml-tools’s documentation!" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> lookml-tools
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="#lookml-tools">LookML Tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#lookml-updater">LookML updater</a></li>
<li class="toctree-l2"><a class="reference internal" href="#lookml-linter">LookML linter</a></li>
<li class="toctree-l2"><a class="reference internal" href="#lookml-grapher">LookML grapher</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#unit-tests">Unit tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="#developer-notes">Developer Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contribute">Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="#release-notes">Release notes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id1">2019-10-30: 2.0.5</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">2019-10-19: 2.0.4</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">2019-09-28: 2.0.3</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">2019-09-28: 2.0.2</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">2019-07-17: 2.0.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">2019-07-17: 2.0.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id7">2019-06-10: 1.0.0</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="README_LINTER.html">LookML Linter</a></li>
<li class="toctree-l1"><a class="reference internal" href="README_GRAPHER.html">LookML Grapher</a></li>
<li class="toctree-l1"><a class="reference internal" href="README_UPDATER.html">LookML Updater</a></li>
<li class="toctree-l1"><a class="reference internal" href="README_DEVELOPER.html">Developer Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/linter/README.html">Linter Example</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/grapher/README.html">Grapher Example</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/updater/README.html">Updater Example</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">lookml-tools</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<p><a class="reference external" href="https://travis-ci.org/ww-tech/lookml-tools"><img alt="https://travis-ci.org/ww-tech/lookml-tools.svg?branch=master" src="https://travis-ci.org/ww-tech/lookml-tools.svg?branch=master" />Build Status</a>
<a class="reference external" href="https://pypi.python.org/pypi/lookml-tools/"><img alt="https://img.shields.io/pypi/pyversions/lookml-tools.svg" src="https://img.shields.io/pypi/pyversions/lookml-tools.svg" />PyPI pyversions</a>
<a class="reference external" href="https://badge.fury.io/py/lookml-tools"><img alt="https://badge.fury.io/py/lookml-tools.svg" src="https://badge.fury.io/py/lookml-tools.svg" />PyPI version</a>
<a class="reference external" href="https://pypi.python.org/pypi/lookml-tools/"><img alt="https://img.shields.io/pypi/l/lookml-tools.svg" src="https://img.shields.io/pypi/l/lookml-tools.svg" />PyPI license</a>
<a class="reference external" href="https://ww-tech.github.io/lookml-tools/"><img alt="https://img.shields.io/website/https/ww-tech.github.io/lookml-tools?down_color=red&down_message=docs&label=docs&up_color=success&up_message=up" src="https://img.shields.io/website/https/ww-tech.github.io/lookml-tools?down_color=red&down_message=docs&label=docs&up_color=success&up_message=up" />Docs status</a></p>
<p><img alt="_images/lookmltools.png" src="_images/lookmltools.png" /></p>
</div>
<div class="section" id="lookml-tools">
<h1>LookML Tools<a class="headerlink" href="#lookml-tools" title="Permalink to this headline">¶</a></h1>
<p>This repository contains some tools to handle best practices of a set of developers working on LookML files.</p>
<p>There are three tools:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">LookML</span> <span class="pre">updater</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">LookML</span> <span class="pre">linter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">LookML</span> <span class="pre">grapher</span></code></p></li>
</ul>
<p>Sites:</p>
<ul class="simple">
<li><p>source: https://github.com/ww-tech/lookml-tools</p></li>
<li><p>documentation: https://ww-tech.github.io/lookml-tools/</p></li>
<li><p>Pypi: https://pypi.org/project/lookml-tools/</p></li>
</ul>
<div class="section" id="lookml-updater">
<h2>LookML updater<a class="headerlink" href="#lookml-updater" title="Permalink to this headline">¶</a></h2>
<p>The first tool helps solve a problem of official definitions of <code class="docutils literal notranslate"><span class="pre">dimensions</span></code> and <code class="docutils literal notranslate"><span class="pre">measures</span></code>—such as in a business glossary—getting out of sync from some other system. The solution implemented here is to have a remote master list whose definitions are propagated to LookML. Thus, given some remote definition for a given LookML <code class="docutils literal notranslate"><span class="pre">dimension</span></code>, <code class="docutils literal notranslate"><span class="pre">dimension_group</span></code>, or <code class="docutils literal notranslate"><span class="pre">measure</span></code>, inject it in the LookML.</p>
<p>Full documentation is <a class="reference internal" href="README_UPDATER.html"><span class="doc">here</span></a>.</p>
</div>
<div class="section" id="lookml-linter">
<h2>LookML linter<a class="headerlink" href="#lookml-linter" title="Permalink to this headline">¶</a></h2>
<p>The second tool helps us check that our LookML conforms to some given coding standards and LookML developer best practices. It runs a series of checks over our LookML files and reports which <code class="docutils literal notranslate"><span class="pre">files</span></code>, or which <code class="docutils literal notranslate"><span class="pre">dimensions</span></code>, <code class="docutils literal notranslate"><span class="pre">dimension_groups</span></code>, or <code class="docutils literal notranslate"><span class="pre">measures</span></code>, fail those checks.</p>
<p>Full documentation is <a class="reference internal" href="README_LINTER.html"><span class="doc">here</span></a>.</p>
</div>
<div class="section" id="lookml-grapher">
<h2>LookML grapher<a class="headerlink" href="#lookml-grapher" title="Permalink to this headline">¶</a></h2>
<p>The third tool creates a “network diagram” of the <code class="docutils literal notranslate"><span class="pre">model</span> <span class="pre">-</span> <span class="pre">explore</span> <span class="pre">-</span> <span class="pre">view</span></code> relationships and writes to an <code class="docutils literal notranslate"><span class="pre">PNG</span></code> image file. The code will also identify any <code class="docutils literal notranslate"><span class="pre">orphans</span></code> i.e. views not referenced by any models or explores.</p>
<p>Full documentation is <a class="reference internal" href="README_GRAPHER.html"><span class="doc">here</span></a>.</p>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>For the grapher, you will need to install grapviz:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">brew</span> <span class="n">install</span> <span class="n">graphviz</span>
</pre></div>
</div>
<p>For all tools, you will need to install dependencies:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
<p>You can install the Python codebase of <code class="docutils literal notranslate"><span class="pre">lookml-tools</span></code> via pip:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">pip</span> <span class="n">install</span> <span class="n">lookml</span><span class="o">-</span><span class="n">tools</span>
</pre></div>
</div>
<p>One user reported having to install a specific version of pandas (<code class="docutils literal notranslate"><span class="pre">pandas==0.24.0</span></code>) to make this all work. YMMV.</p>
<p>Alternatively, you can install with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
</div>
<div class="section" id="unit-tests">
<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Permalink to this headline">¶</a></h2>
<p>There is a test suite with close to 100% code coverage</p>
<p>Run with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pytest</span><span class="o">-</span><span class="n">cov</span>
<span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pytest</span> <span class="o">--</span><span class="n">cov</span><span class="o">=</span><span class="n">lkmltools</span><span class="o">/</span> <span class="n">test</span><span class="o">/*.</span><span class="n">py</span> <span class="p">;</span> <span class="n">coverage</span> <span class="n">html</span>
</pre></div>
</div>
</div>
<div class="section" id="developer-notes">
<h2>Developer Notes<a class="headerlink" href="#developer-notes" title="Permalink to this headline">¶</a></h2>
<p>There are some developer notes for the linter <a class="reference internal" href="README_DEVELOPER.html"><span class="doc">here</span></a>.</p>
</div>
<div class="section" id="contribute">
<h2>Contribute<a class="headerlink" href="#contribute" title="Permalink to this headline">¶</a></h2>
<p>We would love to have your feedback, suggestions, and especially contributions to the project. Create a pull request!</p>
<p>You can reach me directly at carl.anderson@weightwatchers.com as well as <a class="reference external" href="https://twitter.com/LeapingLlamas">@leapingllamas</a> on Twitter.</p>
</div>
<div class="section" id="release-notes">
<h2>Release notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id1">
<h3>2019-10-30: 2.0.5<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<p>added Travis CI config</p>
</div>
<div class="section" id="id2">
<h3>2019-10-19: 2.0.4<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<p>pandas version change to support Python 3.7 (see https://github.com/ww-tech/lookml-tools/pull/5)
Thanks for your contribution https://github.com/m-deck!</p>
<p>Grapher: title now exposed as an option</p>
<p>Grapher can now create animated GIFs</p>
</div>
<div class="section" id="id3">
<h3>2019-09-28: 2.0.3<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>setup.py now uses find_packages()</p>
</div>
<div class="section" id="id4">
<h3>2019-09-28: 2.0.2<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<p>Added missing <strong>init</strong>.py so that packages are recognized</p>
</div>
<div class="section" id="id5">
<h3>2019-07-17: 2.0.1<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<p>Adding missing <code class="docutils literal notranslate"><span class="pre">lkml</span></code> to <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code></p>
</div>
<div class="section" id="id6">
<h3>2019-07-17: 2.0.0<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
<p>Given the impact of the following two changes, this is a major release:</p>
<ul class="simple">
<li><p>swapped out the node-based LookML parser with <a class="reference external" href="https://github.com/joshtemple">Josh Temple’s</a> new Python lkml parser (https://pypi.org/project/lkml/). This simplifies install, dependency management, and underlying parsed JSON format.</p></li>
<li><p>added layer of abstraction via <code class="docutils literal notranslate"><span class="pre">LookML</span></code> and <code class="docutils literal notranslate"><span class="pre">LookMLField</span></code> classes so that rules and other code can query LookML attributes via methods instead of inspecting raw JSON.</p></li>
</ul>
<p>Other changes:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">lkmltools.RuleFactory</span></code> is now a singleton so it is easier for users to register their own rules.</p></li>
<li><p>Can now parameterize any rule in the configuration by adding additional keys to the dictionary for that rule.
For instance, if the config defines <code class="docutils literal notranslate"><span class="pre">{"name":</span> <span class="pre">"MyAwesomeRule",</span> <span class="pre">"run":</span> <span class="pre">true,</span> <span class="pre">"debug":</span> <span class="pre">true,</span> <span class="pre">"strict_mode":true,</span> <span class="pre">length:</span> <span class="pre">6}</span></code> then this whole dictionary is passed into the constructor during rule instantiation.</p></li>
</ul>
</div>
<div class="section" id="id7">
<h3>2019-06-10: 1.0.0<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>initial release</p></li>
</ul>
</div>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>Copyright 2019 WW International, Inc.</p>
<p>Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at</p>
<p>http://www.apache.org/licenses/LICENSE-2.0</p>
<p>Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="README_LINTER.html" class="btn btn-neutral float-right" title="LookML Linter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to lookml-tools’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, WW International, Inc
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>