Skip to content

config

Config dataclass

Basic Internal Configuration.

Attributes:

Name Type Description
SCIFY_DIR Path

Path to cassini module. (Called SCIFY for legacy reasons).

META_DIR_TEMPLATE str

Template filled in to name folder a tier's meta goes into.

DEFAULT_TEMPLATE_DIR Path

Path to where the default templates are stored.

TEMPLATE_EXT str

Extension appended to default template files when created.

BASE_TEMPLATE Path

Path to the basic template, which is used as the default.

Source code in cassini/config.py
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@dataclass
class Config:
    """
    Basic Internal Configuration.

    Attributes
    ----------
    SCIFY_DIR : Path
        Path to cassini module. (Called SCIFY for legacy reasons).
    META_DIR_TEMPLATE : str
        Template filled in to name folder a tier's meta goes into.
    DEFAULT_TEMPLATE_DIR : Path
        Path to where the default templates are stored.
    TEMPLATE_EXT : str
        Extension appended to default template files when created.
    BASE_TEMPLATE : Path
        Path to the basic template, which is used as the default.
    """

    SCIFY_DIR = SCIFY_DIR
    META_DIR_TEMPLATE = ".{}s"

    DEFAULT_TEMPLATE_DIR = SCIFY_DIR / "defaults" / "templates"
    TEMPLATE_EXT = ".tmplt.ipynb"
    BASE_TEMPLATE = DEFAULT_TEMPLATE_DIR / "Tier.tmplt.ipynb"