solidipes.utils package

Submodules

• solidipes.utils.config module
• solidipes.utils.git_infos module
  • GitInfos
    • GitInfos._set_gitlab_uri()
• solidipes.utils.metadata module
• solidipes.utils.progress module
  • ProgressBar
    • ProgressBar._abc_impl
    • ProgressBar.update()
  • ProgressDisplay
    • ProgressDisplay._abc_impl
    • ProgressDisplay.close()
    • ProgressDisplay.reset()
    • ProgressDisplay.start()
  • Spinner
    • Spinner._abc_impl
  • StreamlitProgressBar
    • StreamlitProgressBar._abc_impl
    • StreamlitProgressBar.close()
    • StreamlitProgressBar.reset()
    • StreamlitProgressBar.update()
  • StreamlitSpinner
    • StreamlitSpinner._abc_impl
    • StreamlitSpinner.start()
  • TextProgressBar
    • TextProgressBar._abc_impl
    • TextProgressBar._set_display_info()
    • TextProgressBar.close()
    • TextProgressBar.reset()
    • TextProgressBar.start()
    • TextProgressBar.update()
  • TextSpinner
    • TextSpinner._abc_impl
    • TextSpinner.start()
  • get_progress_bar()
  • get_spinner()
  • get_streamlit_layout()
  • set_streamlit_layout()
• solidipes.utils.solidipes_logging module
  • FormatterShell
    • FormatterShell.MESSAGE_COLORS
    • FormatterShell.PREFIX_COLORS
    • FormatterShell.format()
  • getLogger()
  • invalidPrint()
• solidipes.utils.utils module
  • ExecError
  • _get_config_path()
  • add_completed_stage()
  • bcolors
    • bcolors.BLACK
    • bcolors.BLINK
    • bcolors.BLUE
    • bcolors.BOLD
    • bcolors.BRIGHT_BLACK
    • bcolors.BRIGHT_BLUE
    • bcolors.BRIGHT_CYAN
    • bcolors.BRIGHT_GREEN
    • bcolors.BRIGHT_MAGENTA
    • bcolors.BRIGHT_RED
    • bcolors.BRIGHT_WHITE
    • bcolors.BRIGHT_YELLOW
    • bcolors.CYAN
    • bcolors.GREEN
    • bcolors.MAGENTA
    • bcolors.RED
    • bcolors.RESET
    • bcolors.UNDERLINE
    • bcolors.WHITE
    • bcolors.YELLOW
  • check_process_return()
  • classproperty
  • dict_to_pretty_str()
  • find_config_directory()
  • generate_readme()
  • get_completed_stages()
  • get_config()
  • get_config_path()
  • get_git_repository()
  • get_git_root()
  • get_ignore()
  • get_mimes()
  • get_mimes_path()
  • get_path_relative_to_root()
  • get_path_relative_to_workdir()
  • get_readme_path()
  • get_solidipes_directory()
  • get_study_description_path()
  • get_study_log_path()
  • get_study_metadata()
  • get_study_metadata_path()
  • get_study_root_path()
  • get_user_solidipes_directory()
  • get_zenodo_infos()
  • include_metadata_description()
  • init_git_repository()
  • is_stage_completed()
  • load_yaml()
  • optional_parameter
  • parameter
    • parameter.foo()
    • parameter.foo_setter()
  • populate_metadata_mandatory_fields()
  • populate_parser()
  • remove_completed_stage()
  • rename_file()
  • run_and_check_return()
  • save_yaml()
  • separate_metadata_description()
  • set_config()
  • set_ignore()
  • set_mimes()
  • set_study_metadata()
  • set_zenodo_infos()
  • transform_data_containers_to_dict()
  • transform_dict_to_data_containers()

Module contents

solidipes.utils.add_completed_stage(stage)

class solidipes.utils.bcolors

Bases: object

BLACK = '\x1b[30m'

BLINK = '\x1b[5m'

BLUE = '\x1b[34m'

BOLD = '\x1b[1m'

BRIGHT_BLACK = '\x1b[90m'

BRIGHT_BLUE = '\x1b[94m'

BRIGHT_CYAN = '\x1b[96m'

BRIGHT_GREEN = '\x1b[92m'

BRIGHT_MAGENTA = '\x1b[95m'

BRIGHT_RED = '\x1b[91m'

BRIGHT_WHITE = '\x1b[97m'

BRIGHT_YELLOW = '\x1b[93m'

CYAN = '\x1b[36m'

GREEN = '\x1b[32m'

MAGENTA = '\x1b[35m'

RED = '\x1b[31m'

RESET = '\x1b[0m'

UNDERLINE = '\x1b[4m'

WHITE = '\x1b[37m'

YELLOW = '\x1b[33m'

solidipes.utils.generate_readme(*args, with_title=True, **kwargs)

solidipes.utils.get_completed_stages()

solidipes.utils.get_git_repository(initial_path='')

solidipes.utils.get_git_root(initial_path='')

solidipes.utils.get_ignore(*args, **kwargs) → set[str]

solidipes.utils.get_mimes(*args, **kwargs)

solidipes.utils.get_path_relative_to_root(path)

Express path relative to study root

solidipes.utils.get_readme_path(*args, **kwargs)

solidipes.utils.get_study_description_path(*args, **kwargs)

solidipes.utils.get_study_log_path()

solidipes.utils.get_study_metadata(*args, md_to_html=False, **kwargs)

solidipes.utils.get_study_metadata_path(*args, **kwargs)

solidipes.utils.get_study_root_path(initial_path='', **kwargs)

solidipes.utils.include_metadata_description(metadata, generate_readme=False, use_readme=False, md_to_html=False, **kwargs)

Update metadata description field with DESCRIPTION.md file

solidipes.utils.is_stage_completed(stage)

solidipes.utils.remove_completed_stage(stage)

solidipes.utils.rename_file(old_name, new_name)

solidipes.utils.set_ignore(config: set[str], *args, **kwargs)

solidipes.utils.set_mimes(config, *args, **kwargs)

solidipes.utils.set_study_metadata(config, *args, html_to_md=False, **kwargs)