Metadata-Version: 2.1
Name: intake-nested-yaml-catalog
Version: 0.1.0
Summary: Intake single YAML hierarchical catalog.
Home-page: UNKNOWN
Author: Zillow AI Platform
Author-email: 
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.6
Requires-Dist: vcver
Requires-Dist: intake
Requires-Dist: pandas
Requires-Dist: PyYAML
Requires-Dist: deepmerge

.. image:: https://travis-ci.org/zillow/intake-nested-yaml-catalog.svg?branch=master
    :target: https://travis-ci.org/zillow/intake-nested-yaml-catalog

.. image:: https://coveralls.io/repos/github/zillow/intake-nested-yaml-catalog/badge.svg?branch=master
    :target: https://coveralls.io/github/zillow/intake-nested-yaml-catalog?branch=master

.. image:: https://readthedocs.org/projects/intake-nested-yaml-catalog/badge/?version=latest
    :target: https://intake-nested-yaml-catalog.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

Welcome to Intake plugin for nested YAML catalogs
==================================================

This is an `Intake <https://intake.readthedocs.io/en/latest/quickstart.html>`_ plugin supporting a
single YAML hierarchical catalog to organize datasets and avoid a data swamp.


Example of organizing the datasets by business domain entities:

.. code-block:: yaml

    metadata:
      hierarchical_catalog: true
    entity:
      customer:
        customer_attributes:
          args:
            urlpath: s3://foo
          driver: parquet
      user:
        user_profile:
          args:
            urlpath: s3://foo
          driver: parquet

Can be accessed as:

.. code-block:: python

  df = catalog.entity.customer.customer_attributes.read()


