Source code for sympathy.api.library

# This file is part of Sympathy for Data.
# Copyright (c) 2020, Combine Control Systems AB
#
# SYMPATHY FOR DATA COMMERCIAL LICENSE
# You should have received a link to the License with Sympathy for Data.
from __future__ import annotations
import typing as _t
from .. platform.library import scan_files  # noqa: F401
# Exported as part of api.

from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from . import nodeconfig, typeutil


# Library Plugin interface:




[docs]
def required_features() -> _t.List[str]:
    """
    Returns:
        Features required for enabling the library.
    """
    return []






[docs]
def identifier() -> str:
    """
    Returns:
        Library identifier, which should be unique. See
        https://en.wikipedia.org/wiki/Reverse_domain_name_notation
    """
    return ''






[docs]
def name() -> str:
    """
    Returns:
        Library name as shown in Library View, documentation etc.
    """
    return ''






[docs]
def icon() -> str:
    """
    Returns:
        Path to icon file.
    """
    return ''




def description() -> str:
    """
    Returns:
        Brief description of the library.
    """
    return ''




[docs]
def maintainer() -> str:
    """
    Returns:
        Maintainer. Format Name <email>.
    """
    return ''










[docs]
def version() -> str:
    """
    Returns:

        Version. Format minor.major.micro
    """
    return ''






[docs]
def nodes() -> _t.List[str]:
    """
    Returns:
        Paths to python files containing nodes.
    """
    return []






[docs]
def flows() -> _t.List[str]:
    """
    Returns:
        Paths to python files containing flow nodes.
    """
    return []






[docs]
def plugins() -> _t.List[str]:
    """
    Returns:
        Paths to python files containing node plugins.
    """
    return []




def migrations() -> _t.List[str]:
    """
    Returns:
        Paths to python files containing node migrations.
    """
    return []




[docs]
def tags() -> _t.List[nodeconfig.LibraryTags]:
    """
    Returns:
        Tags for organizing nodes in Library View.
    """
    return []






[docs]
def types() -> _t.List[typeutil.TypeAlias]:
    """
    Returns:
        Port type definitions.
    """
    return []






[docs]
def examples_path() -> str:
    """
    Returns:
        Path to examples.
    """
    return ''






[docs]
def repository_url() -> str:
    """
    Returns:
        URL to public source repository.
    """
    return ''






[docs]
def documentation_url() -> str:
    """
    Returns:
        URL to public documentation.
    """
    return ''






[docs]
def home_url() -> str:
    """
    Returns:
        URL to public home page.
    """
    return ''