# Copyright 2020 AUI, Inc. Washington DC, USA
#
#   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.
"""
this module will be included in the api
"""


def get_data_dir():
    """
    Return the path to the included data folder inside the casaconfig package

    This is a convenience function that can be used to find the included data 
    directory inside the casaconfig package. That location need not be the same 
    as the datapath or measurespath.

    Parameters
       None

    Returns
       string - absolute path to included data directory

    """
    import pkg_resources

    datapath = pkg_resources.resource_filename('casaconfig', '__data__/')

    return datapath
