gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

AppConfig

Extends this class to create an app.

This class defines what code to use to run the app and in which virtual environment if needed.

The sub class must implement the get_folder_path method to return the path of the folder containing the app

Functions
get_app_folder_from_relative_path

Method to get the app folder from a relative path.

current_file : str
path of the current file (__file__)
app_folder_name : str
Return type : str
get_app_folder_path
Return type : str
get_shell_proxy

Override this method to return a env shell proxy if your app needs to run in a virtual environment.

Return type : ShellProxy
classname @classmethod

Returns the name of the class

slugify : bool - False
True to slugify the class name if True
snakefy : bool - False
True to snakefy the class name if True
replace_uppercase : bool - False
Replace upper cases by "-" if True
Return type : str
full_classname @classmethod

Returns the full name of the class

slugify : bool - False
Slugify the returned class name if True
snakefy : bool - False
Snakefy the returned class name if True
Return type : str
get_brick_name @classmethod
Return type : str
get_brick_version @classmethod
Return type : Version
get_human_name @classmethod

Get the human name of the object

Return type : str
get_short_description @classmethod

Get the short description of the object

Return type : str
get_style @classmethod

Get the style of the object

Return type : TypingStyle
get_typing_name @classmethod

Get the typing name of the object Ex: 'RESOURCE.gws_core.Table'

Return type : str
get_typing_name_obj @classmethod
Return type : TypingNameObj
inheritors @classmethod

Get all the classes that inherit this class

Return type : List