librelingo-types 1.1.0

Data types to be used in Python packages for LibreLingo

librelingo_types

Data types to be used in Python packages for LibreLingo

librelingo_types.data_types

Course Objects

class Course(namedtuple("Course", [
    "target_language",
    "source_language",
    "special_characters",
    "modules",
    "license",
    "dictionary"
]))

A LibreLingo course

Usage example:

my_course = Course(
    target_language=Language("English", "en"),
    source_language=Language("Spanish", "es"),
    special_characters=[],
    modules=[module1, module2, module3, module4],
    license=License(
        full_name="Attribution 4.0 International (CC BY 4.0)",
        name="CC BY 4.0",
        link="https://creativecommons.org/licenses/by/4.0/"
    ),
    dictionary=[dict_item1, dict_item2, dict_item3, dict_item4]
)

Language Objects

class Language(namedtuple("Language", ["name", "code"]))

Metadata about a language

Usage example:

    my_language = Language("English", "en")

License Objects

class License(namedtuple("License", [
    "name",
    "full_name",
    "link",
]))

Metadata about the license of a LibreLingo course

Usage example:

License(
    full_name="Attribution 4.0 International (CC BY 4.0)",
    name="CC BY 4.0",
    link="https://creativecommons.org/licenses/by/4.0/"
)

Module Objects

class Module(namedtuple("Module", [
    "title",
    "skills",
]))

A module of a LibreLingo course.

Usage examples:

my_module = Module(title="Basics", skills=[skill1, skill2])

Skill Objects

class Skill(namedtuple("Skill", [
    "name",
    "id",
    "words",
    "phrases",
    "image_set",
    "dictionary",
    "introduction",
]))

A skill of a module of a LibreLingo course.

Notes:

id: Needs to be a unique ID. Use uuidv4.

Usage examples:

my_skill = Skill(
    name="Animals",
    id="3adc78da-ea42-4ecd-9e3d-2e0986a3b914",
    words=[word1, word2, word3],
    phrases=[phrases1, phrases2, phrases3],
    image_set=["cat1", "dog2", "horse1"],
    dictionary=[dict_item_1, dict_item_2, dict_item_3, dict_item_4],
    introduction="My *markdown* text",
)

Word Objects

class Word(namedtuple("Word", [
    "in_target_language",
    "in_source_language",
    "pictures",
]))

A new word taught in a LibreLingo skill.

Notes:

in_source_language: List of accepted forms in the target language of the course. The first item in the list is the main form. The main form is the only form that is shown in the course but all forms are accepted as answers.

in_target_language: List of accepted forms in the target language of the course. The first item in the list is the main form. The main form is the only form that is shown in the course but all forms are accepted as answers.

Usage example:

my_word = Word(
    in_target_language=["perro"],
    in_target_language=["dog"],
    pictures=["dog1", "dog2", "dog3"]
)

Phrase Objects

class Phrase(namedtuple("Phrase", [
    "in_target_language",
    "in_source_language",
]))

A new phrase taught in a LibreLingo skill.

Notes:

in_source_language: List of accepted forms in the target language of the course. The first item in the list is the main form. The main form is the only form that is shown in the course but all forms are accepted as answers.

in_target_language: List of accepted forms in the target language of the course. The first item in the list is the main form. The main form is the only form that is shown in the course but all forms are accepted as answers.

Usage example:

my_phrase = Phrase(
    in_target_language=["perro"],
    in_target_language=["dog"],
)

DictionaryItem Objects

class DictionaryItem(namedtuple("DictionaryItem", [
    "word",
    "definition",
    "is_in_target_language"
]))

A dictionary item for a LibreLingo course. It contains the definition of a word. The word can be either in the source language or the target language.

# Definition in the source language (Spanish in this case)
my_dict_item_1 = DictionaryItem("hablo", "I speak", False)

# Definition in the target language (English in this case)
my_dict_item_2 = DictionaryItem("speak", "hablo", True)