interface.py

""" This module contains all the interfaces for data models used."""

# standard imports
from typing import Optional, List

# third-party imports
from pydantic import BaseModel, Extra


class ProgrammingLanguage(BaseModel, extra=Extra.allow):
    """Interface for programming language."""

    name: str
    url: str
    licenses: List[str]
    description: Optional[str] = None


class Licenses(BaseModel, extra=Extra.allow):
    """Interface for opensource licenses."""

    name: str
    spdx_id: Optional[str] = None


class Organization(BaseModel, extra=Extra.allow):
    """Interface for organization."""

    name: str
    description: Optional[str] = None
    url: Optional[str] = None


class ToolCategory(BaseModel, extra=Extra.allow):
    """Interface for tree of software tool categorizations."""

    name: str
    parent: Optional[str] = None
    description: Optional[str] = None


class SoftwareTool(BaseModel, extra=Extra.allow):
    """ Interface for software tool. """

    name: str 
    categories: List[str]
    languages: List[str]
    organizations: List[str]
    licenses: List[str]
    description: Optional[str] = None
    url_website: Optional[str] = None
    url_sourcecode: Optional[str] = None
    url_docs: Optional[str] = None