This repository contains some tools to handle best practices of a set of developers working on LookML files.
There are three tools:
LookML updaterLookML linterLookML grapher
Sites:
- source: https://github.com/ww-tech/lookml-tools
- documentation: https://ww-tech.github.io/lookml-tools/
- Pypi: https://pypi.org/project/lookml-tools/
The first tool helps solve a problem of official definitions of dimensions and measures—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 dimension, dimension_group, or measure, inject it in the LookML.
Full documentation is here.
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 files, or which dimensions, dimension_groups, or measures, fail those checks.
Full documentation is here.
The third tool creates a "network diagram" of the model - explore - view relationships and writes to an PNG image file. The code will also identify any orphans i.e. views not referenced by any models or explores.
Full documentation is here.
For the grapher, you will need to install grapviz:
brew install graphviz
For all tools, you will need to install dependencies:
pip install -r requirements.txt
You can install the Python codebase of lookml-tools via pip:
pip install lookml-tools
One user reported having to install a specific version of pandas (pandas==0.24.0) to make this all work. YMMV.
Alternatively, you can install with
python setup.py install
There is a test suite with close to 100% code coverage
Run with
pip install pytest-cov
python -m pytest --cov=lkmltools/ test/*.py ; coverage html
There are some developer notes for the linter here.
We would love to have your feedback, suggestions, and especially contributions to the project. Create a pull request!
You can reach me directly at [email protected] as well as @leapingllamas on Twitter.
added Travis CI config
pandas version change to support Python 3.7 (see #5) Thanks for your contribution https://github.com/m-deck!
Grapher: title now exposed as an option
Grapher can now create animated GIFs
setup.py now uses find_packages()
Added missing init.py so that packages are recognized
Adding missing lkml to requirements.txt
Given the impact of the following two changes, this is a major release:
- swapped out the node-based LookML parser with Josh Temple's new Python lkml parser (https://pypi.org/project/lkml/). This simplifies install, dependency management, and underlying parsed JSON format.
- added layer of abstraction via
LookMLandLookMLFieldclasses so that rules and other code can query LookML attributes via methods instead of inspecting raw JSON.
Other changes:
lkmltools.RuleFactoryis now a singleton so it is easier for users to register their own rules.- Can now parameterize any rule in the configuration by adding additional keys to the dictionary for that rule.
For instance, if the config defines
{"name": "MyAwesomeRule", "run": true, "debug": true, "strict_mode":true, length: 6}then this whole dictionary is passed into the constructor during rule instantiation.
- initial release
Copyright 2019 WW International, Inc.
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
http://www.apache.org/licenses/LICENSE-2.0
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.