hipscat.inspection.almanac_info

Module Contents

Classes

AlmanacInfo

Container for parsed almanac information.

class AlmanacInfo

Container for parsed almanac information.

file_path: str = ''

storage_options: Dict[Any, Any] | None

namespace: str = ''

catalog_path: str = ''

catalog_name: str = ''

catalog_type: str = ''

primary: str | None

join: str | None

primary_link: typing_extensions.Self | None

join_link: typing_extensions.Self | None

sources: List[typing_extensions.Self]

objects: List[typing_extensions.Self]

margins: List[typing_extensions.Self]

associations: List[typing_extensions.Self]

associations_right: List[typing_extensions.Self]

indexes: List[typing_extensions.Self]

creators: List[str]

description: str = ''

version: str = ''

deprecated: str = ''

catalog_info: dict

catalog_info_object: hipscat.catalog.dataset.base_catalog_info.BaseCatalogInfo | None

__post_init__()

static get_default_dir() → str

Fetch the default directory for environment variables.

This is set via the environment variable: HIPSCAT_ALMANAC_DIR

To set this in a linux-like environment, use a command like:

export HIPSCAT_ALMANAC_DIR=/data/path/to/almanacs

This will also attempt to expand any environment variables WITHIN the default directory environment variable. This can be useful in cases where:

$HIPSCAT_ALMANAC_DIR=$HIPSCAT_DEFAULT_DIR/almanacs/

classmethod from_catalog_dir(catalog_base_dir: str, storage_options: Dict[Any, Any] | None = None) → typing_extensions.Self

Create almanac information from the catalog information found at the target directory

classmethod from_file(file: str, storage_options: Dict[Any, Any] | None = None) → typing_extensions.Self

Create almanac information from an almanac file.

write_to_file(directory=None, default_dir=True, fmt='yml', storage_options: Dict[Any, Any] | None = None)

Write the almanac to an almanac file