gen_py_tool.pro package

Subpackages

Module contents

Module
__init__.py
Copyright
Copyright (C) 2017 Vladimir Roncevic <elektron.ronca@gmail.com> gen_py_tool is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. gen_py_tool is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Info
Defined class GenPro with attribute(s) and method(s). Generate project by setup of parameters, templates, schemas.
class gen_py_tool.pro.GenPro(project_name, verbose=False)[source]

Bases: ats_utilities.config_io.base_check.FileChecking, gen_py_tool.pro.config.ProConfig, gen_py_tool.pro.config.pro_name.ProName, gen_py_tool.pro.config.pro_type.ProType

Defined class GenPro with attribute(s) and method(s). Generate project by setup of parameters, templates, schemas. It defines:

attributes:
GEN_VERBOSE - console text indicator for process-phase.
PRO_STRUCTURE - project structure.
methods:
__init__ - initial constructor.
is_pro_config_ok - checking is project configuration ok.
gen_pro - generate project structure.
__str__ - dunder method for GenPro.
GEN_VERBOSE = 'GEN_PY_TOOL::PRO::GEN_PRO'
PRO_STRUCTURE = '/../conf/project.yaml'
VERBOSE = 'ATS_UTILITIES'
gen_pro(verbose=False)[source]

Generate project structure.

Parameters:verbose (<bool>) – enable/disable verbose option.
Returns:boolean status, True (success) | False.
Return type:<bool>
Exceptions:None
is_pro_config_ok(verbose=False)[source]

Checking is project configuration ok.

Parameters:verbose (<bool>) – enable/disable verbose option.
Returns:boolean status, True (ok) | False.
Return type:<bool>
Exceptions:None