Skip to content

chronulus.environment

Env

Bases: BaseSettings

Environment settings class for managing API configuration.

This class handles environment variables and configuration for the Chronulus API, with support for loading from environment files.

Attributes:

Name Type Description
API_URI str

The URI for the Chronulus API endpoint.
CHRONULUS_API_KEY str or None

The API key for authentication. Defaults to the value in CHRONULUS_API_KEY environment variable.
Notes

Configuration is loaded from environment files in order of precedence, with the default.env file serving as the base configuration.

Source code in src/chronulus/environment.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class Env(BaseSettings):
    """
    Environment settings class for managing API configuration.

    This class handles environment variables and configuration for the Chronulus API,
    with support for loading from environment files.

    Attributes
    ----------
    API_URI : str
        The URI for the Chronulus API endpoint.
    CHRONULUS_API_KEY : str or None
        The API key for authentication. Defaults to the value in CHRONULUS_API_KEY
        environment variable.

    Notes
    -----
    Configuration is loaded from environment files in order of precedence,
    with the default.env file serving as the base configuration.
    """
    API_URI: str
    CHRONULUS_API_KEY: str | None = Field(default=os.environ.get("CHRONULUS_API_KEY"))

    model_config = SettingsConfigDict(
        env_file=(
            # List them in order of precedence (last one wins)
            get_default_env_path()
        ),
        # Optional: Use case-sensitive names (default is case-insensitive)
        case_sensitive=True,
    )

BaseEnv

Base class for environment-aware components.

This class provides basic environment configuration and header management for API interactions.

Parameters:

Name Type Description Default
**kwargs

Keyword arguments to pass to the Env initialization.

 {}

Attributes:

Name Type Description
env Env

The environment settings instance.
headers dict

Default headers for API requests, including authentication.
Source code in src/chronulus/environment.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
class BaseEnv:
    """
    Base class for environment-aware components.

    This class provides basic environment configuration and header management
    for API interactions.

    Parameters
    ----------
    **kwargs
        Keyword arguments to pass to the Env initialization.

    Attributes
    ----------
    env : Env
        The environment settings instance.
    headers : dict
        Default headers for API requests, including authentication.
    """

    def __init__(self, **kwargs):
        self.env = Env(**kwargs)
        self.headers = get_default_headers(self.env)

get_default_env_path()

Get the path to the default environment file in the package.

Returns:

Type Description
str

The absolute path to the default.env file.
Source code in src/chronulus/environment.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
def get_default_env_path():
    """
    Get the path to the default environment file in the package.

    Returns
    -------
    str
        The absolute path to the default.env file.
    """
    # Get the package directory
    for file in resources.files("chronulus.etc").iterdir():
        if file.is_file() and file.name == 'default.env':
            return str(file)

get_default_headers(env)

Generate default headers for API requests.

Parameters:

Name Type Description Default
env Env

The environment settings instance containing the API key.

 required

Returns:

Type Description
dict

A dictionary containing the X-API-Key header with the API key.
Source code in src/chronulus/environment.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def get_default_headers(env: Env):
    """
    Generate default headers for API requests.

    Parameters
    ----------
    env : Env
        The environment settings instance containing the API key.

    Returns
    -------
    dict
        A dictionary containing the X-API-Key header with the API key.
    """
    return {'X-API-Key': env.CHRONULUS_API_KEY}