__init__.py

# Copyright 2017 by Kurt Rathjen. All Rights Reserved.
#
# This library is free software: you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation, either
# version 3 of the License, or (at your option) any later version.
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.

import os
import sys
import json


__version__ = "2.4.0.b19"

_config = None
_resource = None


PATH = os.path.abspath(__file__)
DIRNAME = os.path.dirname(PATH)
PACKAGES_PATH = os.path.join(DIRNAME, "packages")
RESOURCE_PATH = os.path.join(DIRNAME, "resource")
HELP_URL = "http://www.studiolibrary.com"


class Config(dict):
    """
    A custom config parser for passing JSON files.
    
    We use this instead of the standard ConfigParser as the JSON format
    can support list and dict types.
    
    This parser can also support comments using the following style "//"
    """

    @staticmethod
    def paths():
        """
        Return all possible config paths.
        
        :rtype: list[str] 
        """
        cwd = os.path.dirname(__file__)
        paths = [os.path.join(cwd, "config", "default.json")]

        path = os.environ.get("STUDIO_LIBRARY_CONFIG_PATH")
        path = path or os.path.join(cwd, "config", "config.json")

        if os.path.exists(path):
            paths.append(path)

        return paths

    def read(self):
        """Read all paths and overwrite the keys with each successive file."""
        self.clear()

        for path in self.paths():
            lines = []

            with open(path) as f:
                for line in f.readlines():
                    if not line.strip().startswith('//'):
                        lines.append(line)

            data = '\n'.join(lines)
            if data:
                self.update(json.loads(data))


def config():
    """
    Read the config data for the current environment.

    :rtype: Config 
    """
    global _config

    if not _config:
        _config = Config()
        _config.read()

    return _config


def version():
    """
    Return the current version of the Studio Library

    :rtype: str
    """
    return __version__


def resource():
    """
    Return a resource object for getting content from the resource folder.

    :rtype: studioqt.Resource
    """
    global _resource

    if not _resource:
        _resource = studioqt.Resource(RESOURCE_PATH)

    return _resource


def setup(path):
    """
    Setup the packages that have been decoupled from the Studio Library.

    :param path: The folder location that contains all the packages.
    :type path: str

    :rtype: None
    """
    if os.path.exists(path) and path not in sys.path:
        sys.path.append(path)


setup(PACKAGES_PATH)


import studioqt

from studiolibrary.cmds import *
from studiolibrary.library import Library
from studiolibrary.libraryitem import LibraryItem
from studiolibrary.librarywidget import LibraryWidget
from studiolibrary.main import main

import studiolibrary.folderitem

# Wrapping the following functions for convenience
app = studioqt.app