Utilities

nemspy.utilities.repository_root(path: Optional[os.PathLike] = None) → pathlib.Path

find enclosing Git repository

Parameters

path – path to start at

Returns

path to root of Git repository

nemspy.utilities.get_logger(name: str, log_filename: Optional[os.PathLike] = None, file_level: Optional[int] = None, console_level: Optional[int] = None, log_format: Optional[str] = None) → logging.Logger

instantiate logger instance

Parameters

• name – name of logger

• log_filename – path to log file

• file_level – minimum log level to write to log file

• console_level – minimum log level to print to console

• log_format – logger message format

Returns

instance of a Logger object

nemspy.utilities.create_symlink(source_filename: os.PathLike, symlink_filename: os.PathLike, relative: bool = False)

Parameters

• source_filename – path to point to

• symlink_filename – path at which to create symlink

• relative – make symlink relative to source location

nemspy.utilities.parse_datetime(value: Union[int, float, str, datetime.datetime]) → datetime.datetime

attempt to parse a datetime from the given value

Parameters

value – value to parse

Returns

parsed datetime

class nemspy.configuration.ensure_directory(directory: os.PathLike)

ensure that a directory exists

Parameters

directory – directory path to ensure

Returns

path to ensured directory