Metadata-Version: 2.0
Name: lookml-gen
Version: 0.1.8
Summary: Programmatically generate LookML
Home-page: https://github.com/symphonyrm/lookml-gen
Author: Joe Schmid
Author-email: jschmid@symphonyrm.com
License: Apache Software License 2.0
Keywords: lookml-gen
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: six (>=1.10.0)

===============================
LookML Generator
===============================


.. image:: https://img.shields.io/pypi/v/lookml-gen.svg
    :target: https://pypi.python.org/pypi/lookml-gen

.. image:: https://travis-ci.org/symphonyrm/lookml-gen.svg?branch=master
    :target: https://travis-ci.org/symphonyrm/lookml-gen

.. image:: https://readthedocs.org/projects/lookml-gen/badge/?version=latest
    :target: http://lookml-gen.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://pyup.io/repos/github/symphonyrm/lookml-gen/shield.svg
    :target: https://pyup.io/repos/github/symphonyrm/lookml-gen/
    :alt: Updates


Programmatically generate LookML


* Free software: Apache Software License 2.0
* Documentation: https://lookml-gen.readthedocs.io.


Features
--------

* Generate LookML views programmatically
* Include dimensions, dimension groups, filters, and measures in your views
* Support Persistent Derived Tables (PDTs)
* Write output to files or StringIO buffers

Quick Start
-----------

Install it::

    pip install lookml-gen

Use it::

    from lookmlgen.view import View
    from lookmlgen.field import Dimension, DimensionGroup, Measure
    from lookmlgen.base_generator import GeneratorFormatOptions

    view_name = 'my_view'
    v = View(view_name, sql_table_name='my_table')
    v.add_field(Dimension('id', type='number', primary_key=True))
    v.add_field(DimensionGroup('created'))
    v.add_field(Dimension('name'))
    v.add_field(Dimension('quantity', type='number'))
    v.add_field(Measure('total_quantity', sql='${TABLE}.quantity', type='sum'))

    with open('%s.view.lkml' % view_name, 'w') as f:
        v.generate_lookml(f, GeneratorFormatOptions(view_fields_alphabetical=False))

See it::

    # STOP! This file was generated by an automated process.
    # Any edits you make will be lost the next time it is
    # re-generated.
    view: my_view {
      sql_table_name: my_table ;;

      dimension: id {
        type: number
        primary_key: yes
        sql: ${TABLE}.id ;;
      }

      dimension_group: created {
        type: time
        timeframes: ["time", "date", "week", "month"]
        datatype: datetime
        sql: ${TABLE}.created ;;
      }

      dimension: name {
        sql: ${TABLE}.name ;;
      }

      dimension: quantity {
        type: number
        sql: ${TABLE}.quantity ;;
      }

      measure: total_quantity {
        type: sum
        sql: ${TABLE}.quantity ;;
      }
    }

TODOs
-----

Full LookML support is far from complete right now. At the moment only very basic
aspects of Views and Fields are supported and there is no support for Explores yet.
However, it does cover the most common functionality, including Persistent Derived
Tables. The code can easily be extended and we'd love to get pull requests to fill
out additional functionality.

Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage



=======
History
=======

0.1.0 (2017-04-17)
------------------
* First release on PyPI.

0.1.1 (2017-04-17)
------------------
* Switch to lookmlgen for module name

0.1.2 (2017-04-18)
------------------
* Move primary_key from Field to Dimension
* Remove stub for command line use
* Add docstrings

0.1.3 (2017-04-20)
------------------
* Default sql parameter of fields to ${TABLE}.field_name

0.1.4 (2017-04-20)
------------------
* Support sql_table_name
* Add formatting option for alphabetical view fields or not

0.1.5 (2017-04-24)
------------------
* Rename add_derived_table method to set_derived_table in View

0.1.7 (2017-06-20)
------------------
* Added formatting option to omit timeframe generating params if they're not set
* Update pytest to 3.1.2, cryptography to 1.9, sphinx to 1.6.2

0.1.8 (2017-06-23)
------------------
* Add a description parameter to fields


