Links
GitHub Project Page
PyPI (pip) Package
Documentation at Read the Docs
Report a Bug or a Feature Request
Issue Tracker at GitHub
Installation and Usage
Installation and Usage
Prerequisites
Installation
Using a Virtual Environment
Virtualenv Setup
Pipenv Setup
Installation of Buildnis
Installation using Pip
Installation using Pipenv
No Package Installation
Usage
Command Line Arguments
Show Help Text
Show Version
Main Argument - The Project Configuration
Build Stages
Output and Script Paths
Logging Options
Configuration
Build Stages
License
Customizing
Supported Configurations
Supported OSes
Supported C++ Compilers
Linux
Mac OS X
Windows
Supported Fortran Compilers
Linux
Mac OS X
Windows
Supported Interpreters
Linux
Mac OS X
Windows
Supported Documentation Tools
Linux
Mac OS X
Windows
Supported Build Tools
Customizing Buildnis
Extending Buildnis
Developing Buildnis
Developer Reference
modules.config package
Submodules
modules.config.build_config module
modules.config.check module
modules.config.config module
modules.config.config_dir_json module
modules.config.config_files module
modules.config.config_values module
modules.config.configure_build module
modules.config.host module
modules.config.host_linux module
modules.config.host_osx module
modules.config.host_windows module
modules.config.json_base_class module
modules.config.module module
modules.config.project_dependency module
Module contents
modules.builds package
Module contents
modules.helpers package
Submodules
modules.helpers.commandline module
modules.helpers.commandline_arguments module
modules.helpers.config_parser module
modules.helpers.execute module
modules.helpers.file_compare module
modules.helpers.files module
modules.helpers.json module
modules.helpers.logging module
modules.helpers.placeholder_regex module
modules.helpers.web module
Module contents
Indices
Index
Python Module Index
Buildnis
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
W
A
addAttributesIfNotExist() (JSONBaseClass method)
arch (Check attribute)
Arch (in module buildnis.modules.config)
areHashesSame() (in module buildnis.modules.helpers.file_compare)
args (EnvArgs attribute)
,
[1]
(ExeArgs attribute)
,
[1]
B
build_targets (CommandlineArguments attribute)
build_tool_cfgs (Check attribute)
build_tools_Cfg (ConfigFiles attribute)
build_tools_cfg (ConfigFiles attribute)
BuildCfg (class in buildnis.modules.config.build_config)
buildnis.modules.builds
module
buildnis.modules.config
module
buildnis.modules.config.build_config
module
buildnis.modules.config.check
module
buildnis.modules.config.config
module
buildnis.modules.config.config_dir_json
module
buildnis.modules.config.config_files
module
buildnis.modules.config.config_values
module
buildnis.modules.config.configure_build
module
buildnis.modules.config.host
module
buildnis.modules.config.host_linux
module
buildnis.modules.config.host_osx
module
buildnis.modules.config.host_windows
module
buildnis.modules.config.json_base_class
module
buildnis.modules.config.module
module
buildnis.modules.config.project_dependency
module
buildnis.modules.helpers
module
buildnis.modules.helpers.commandline
module
buildnis.modules.helpers.commandline_arguments
module
buildnis.modules.helpers.config_parser
module
buildnis.modules.helpers.execute
module
buildnis.modules.helpers.file_compare
module
buildnis.modules.helpers.files
module
buildnis.modules.helpers.json
module
buildnis.modules.helpers.logging
module
buildnis.modules.helpers.placeholder_regex
module
buildnis.modules.helpers.web
module
C
cfg_path (ConfigDirJson attribute)
Check (class in buildnis.modules.config.check)
checkCmdLineArgs() (in module buildnis.modules.helpers.commandline)
checkConfigName() (in module buildnis.modules.helpers.json)
checkConfigVersion() (in module buildnis.modules.helpers.json)
checkDependencies() (Config method)
(ProjectDependency method)
,
[1]
checkIfExists() (in module buildnis.modules.helpers.files)
checkIFInstalled() (ProjectDependency method)
checkIfIsDir() (in module buildnis.modules.helpers.files)
checkIfIsFile() (in module buildnis.modules.helpers.files)
checkIfIsLink() (in module buildnis.modules.helpers.files)
checkTargetArgs() (CommandlineArguments method)
checkVersions() (Check method)
,
[1]
CmdOutput (class in buildnis.modules.config)
collectLinuxConfig() (Host method)
collectLinuxCpuGpuRam() (Host method)
collectOSXConfig() (Host method)
collectWinCpuGpuRam() (Host method)
collectWindowsConfig() (Host method)
CommandlineArguments (class in buildnis.modules.helpers.commandline_arguments)
conf_dir (CommandlineArguments attribute)
conf_scripts_dir (CommandlineArguments attribute)
Config (class in buildnis.modules.config.config)
config_path (ProjectDependency attribute)
ConfigDirJson (class in buildnis.modules.config.config_dir_json)
ConfigFiles (class in buildnis.modules.config.config_files)
ConfigTuple (class in buildnis.modules.config.config_files)
configureBuild() (in module buildnis.modules.config.configure_build)
ConfigVersion (class in buildnis.modules.config)
connectInTarget() (Config method)
connectModulesBuildTools() (Config method)
current_date_regex (in module buildnis.modules.helpers.placeholder_regex)
current_day_regex (in module buildnis.modules.helpers.placeholder_regex)
current_month_regex (in module buildnis.modules.helpers.placeholder_regex)
current_time_regex (in module buildnis.modules.helpers.placeholder_regex)
current_year_regex (in module buildnis.modules.helpers.placeholder_regex)
D
deleteConfigs() (in module buildnis.modules.helpers.commandline_arguments)
deleteDirs() (in module buildnis.modules.helpers.files)
deleteFiles() (in module buildnis.modules.helpers.files)
deleteLogfiles() (in module buildnis.modules.helpers.commandline_arguments)
dependencies (ProjectDependency attribute)
do_build (CommandlineArguments attribute)
do_check_what_to_do (CommandlineArguments attribute)
do_clean (CommandlineArguments attribute)
do_configure (CommandlineArguments attribute)
do_distclean (CommandlineArguments attribute)
do_install (CommandlineArguments attribute)
do_source (EnvArgs attribute)
,
[1]
doAppendTarget() (CommandlineArguments static method)
doDistClean() (in module buildnis.modules.helpers.commandline_arguments)
doDownload() (in module buildnis.modules.helpers.web)
doesExecutableWork() (in module buildnis.modules.helpers.execute)
download() (ProjectDependency method)
download_dir (ProjectDependency attribute)
download_url (ProjectDependency attribute)
E
EnvArgs (class in buildnis.modules.helpers.execute)
err_out (CmdOutput attribute)
,
[1]
exe (ExeArgs attribute)
,
[1]
ExeArgs (class in buildnis.modules.helpers.execute)
executable_argument (ProjectDependency attribute)
executable_check_regex (ProjectDependency attribute)
ExecuteException
exists (ConfigTuple attribute)
,
[1]
expandAllPlaceholders() (Config method)
(JSONBaseClass method)
,
[1]
expandItem() (in module buildnis.modules.helpers.config_parser)
F
file_name (ConfigDirJson attribute)
FileCompare (class in buildnis.modules.helpers.file_compare)
FileCompareException
FilePath (in module buildnis.modules.config)
flattenList() (CommandlineArguments method)
fromReadJSON() (BuildCfg class method)
(BuildCfg method)
(ModuleCfg class method)
(ModuleCfg method)
G
generateHash() (FileCompare method)
,
[1]
getCPU() (Host method)
GetCPUInfo() (Host method)
getCPUInfo() (in module buildnis.modules.config.host_windows)
getCPUName() (in module buildnis.modules.config.host_windows)
getCPUNameLinux() (in module buildnis.modules.config.host_linux)
getCPUNameOSX() (in module buildnis.modules.config.host_osx)
getGPU() (Host method)
getGPUInfo() (in module buildnis.modules.config.host_windows)
getGPULspci() (Host method)
getGPUNamesLinux() (Host method)
(in module buildnis.modules.config.host_linux)
getGPUNamesSbinLinux() (in module buildnis.modules.config.host_linux)
getGPUOSX() (in module buildnis.modules.config.host_osx)
getGPUSbinLspci() (Host method)
getJSONDict() (in module buildnis.modules.helpers.json)
getL2CacheLinux() (in module buildnis.modules.config.host_linux)
getL2CacheOSX() (in module buildnis.modules.config.host_osx)
getL3CacheLinux() (in module buildnis.modules.config.host_linux)
getL3CacheOSX() (in module buildnis.modules.config.host_osx)
getMemInfo() (in module buildnis.modules.config.host_windows)
getNumCoresLinux() (in module buildnis.modules.config.host_linux)
getNumCoresOSX() (in module buildnis.modules.config.host_osx)
getNumLogCoresLinux() (in module buildnis.modules.config.host_linux)
getNumLogCoresOSX() (in module buildnis.modules.config.host_osx)
getOSInfo() (Host method)
getOSMajVers() (in module buildnis.modules.config.host_linux)
getOSName() (in module buildnis.modules.config.host_osx)
getOSVer() (in module buildnis.modules.config.host_linux)
getPlaceholder() (in module buildnis.modules.helpers.config_parser)
getProgramLogger() (in module buildnis.modules.helpers.logging)
getRAM() (Host method)
getRAMSizeLinux() (in module buildnis.modules.config.host_linux)
getRAMSizeOSX() (in module buildnis.modules.config.host_osx)
group (RunRegex attribute)
,
[1]
H
hasChanged() (FileCompare method)
hasConfigChangedOnDisk() (JSONBaseClass method)
,
[1]
hash (FileCompare attribute)
hashFile() (in module buildnis.modules.helpers.files)
Host (class in buildnis.modules.config.host)
host_cfg (ConfigFiles attribute)
,
[1]
HOST_CPU_ARCH (in module buildnis.modules.config.config_values)
host_cpu_arch_regex (in module buildnis.modules.helpers.placeholder_regex)
HOST_NAME (in module buildnis.modules.config.config_values)
host_name_regex (in module buildnis.modules.helpers.placeholder_regex)
HOST_NUM_CORES (in module buildnis.modules.config.config_values)
host_num_cores_regex (in module buildnis.modules.helpers.placeholder_regex)
HOST_NUM_LOG_CORES (in module buildnis.modules.config.config_values)
host_num_log_cores_regex (in module buildnis.modules.helpers.placeholder_regex)
HOST_OS (in module buildnis.modules.config.config_values)
host_os_regex (in module buildnis.modules.helpers.placeholder_regex)
I
ifConfigureDeleteProjectJSON() (in module buildnis.modules.config.configure_build)
initAttribs() (BuildCfg method)
(CommandlineArguments method)
initStages() (BuildCfg method)
install() (ProjectDependency method)
install_arguments (ProjectDependency attribute)
install_cmd (ProjectDependency attribute)
install_targets (CommandlineArguments attribute)
installDep() (ProjectDependency method)
,
[1]
is_checked (ProjectDependency attribute)
isBuildToolCfgOK() (Check method)
,
[1]
isDependencyFulfilled() (ProjectDependency method)
,
[1]
isExecuteableDep() (ProjectDependency method)
,
[1]
isSame() (FileCompare method)
,
[1]
isSameFile() (FileCompare method)
J
JSONBaseClass (class in buildnis.modules.config.json_base_class)
L
log_file (CommandlineArguments attribute)
log_level (CommandlineArguments attribute)
M
major (ConfigVersion attribute)
makeDirIfNotExists() (in module buildnis.modules.helpers.files)
minor (ConfigVersion attribute)
module
buildnis.modules.builds
buildnis.modules.config
buildnis.modules.config.build_config
buildnis.modules.config.check
buildnis.modules.config.config
buildnis.modules.config.config_dir_json
buildnis.modules.config.config_files
buildnis.modules.config.config_values
buildnis.modules.config.configure_build
buildnis.modules.config.host
buildnis.modules.config.host_linux
buildnis.modules.config.host_osx
buildnis.modules.config.host_windows
buildnis.modules.config.json_base_class
buildnis.modules.config.module
buildnis.modules.config.project_dependency
buildnis.modules.helpers
buildnis.modules.helpers.commandline
buildnis.modules.helpers.commandline_arguments
buildnis.modules.helpers.config_parser
buildnis.modules.helpers.execute
buildnis.modules.helpers.file_compare
buildnis.modules.helpers.files
buildnis.modules.helpers.json
buildnis.modules.helpers.logging
buildnis.modules.helpers.placeholder_regex
buildnis.modules.helpers.web
ModuleCfg (class in buildnis.modules.config.module)
N
name (ProjectDependency attribute)
O
ok_if_executable (ProjectDependency attribute)
ok_if_exists (ProjectDependency attribute)
okIfExecutable() (ProjectDependency method)
okIfExists() (ProjectDependency method)
os_name (Check attribute)
os_name_linux_regex (in module buildnis.modules.helpers.placeholder_regex)
os_name_osx_regex (in module buildnis.modules.helpers.placeholder_regex)
os_name_windows_regex (in module buildnis.modules.helpers.placeholder_regex)
OSName (in module buildnis.modules.config)
P
parseBuildCfgs() (Config method)
parseCommandLine() (in module buildnis.modules.helpers.commandline)
parseConfigElement() (in module buildnis.modules.helpers.config_parser)
parseCPUInfoLine() (Host method)
parseItem() (in module buildnis.modules.helpers.json)
parseList() (in module buildnis.modules.helpers.config_parser)
(in module buildnis.modules.helpers.json)
parseModuleCfgs() (Config method)
parseRAMline() (Host method)
path (ConfigTuple attribute)
,
[1]
(FileCompare attribute)
path_obj (FileCompare attribute)
placeholder_regex (in module buildnis.modules.helpers.placeholder_regex)
printHostInfo() (in module buildnis.modules.config.host)
PROJECT_AUTHOR (in module buildnis.modules.config.config_values)
project_author_regex (in module buildnis.modules.helpers.placeholder_regex)
project_cfg (ConfigFiles attribute)
,
[1]
project_cfg_dir_regex (in module buildnis.modules.helpers.placeholder_regex)
PROJECT_COMPANY (in module buildnis.modules.config.config_values)
project_company_regex (in module buildnis.modules.helpers.placeholder_regex)
PROJECT_CONFIG_DIR_PATH (in module buildnis.modules.config.config_values)
project_config_file (CommandlineArguments attribute)
PROJECT_COPYRIGHT_INFO (in module buildnis.modules.config.config_values)
project_copyright_info_regex (in module buildnis.modules.helpers.placeholder_regex)
project_dep_cfg (ConfigFiles attribute)
,
[1]
PROJECT_EMAIL (in module buildnis.modules.config.config_values)
project_email_regex (in module buildnis.modules.helpers.placeholder_regex)
PROJECT_NAME (in module buildnis.modules.config.config_values)
project_name_regex (in module buildnis.modules.helpers.placeholder_regex)
PROJECT_ROOT (in module buildnis.modules.config.config_values)
project_root_regex (in module buildnis.modules.helpers.placeholder_regex)
PROJECT_VERSION (in module buildnis.modules.config.config_values)
project_version_regex (in module buildnis.modules.helpers.placeholder_regex)
PROJECT_WEB_URL (in module buildnis.modules.config.config_values)
project_web_url_regex (in module buildnis.modules.helpers.placeholder_regex)
ProjectDependency (class in buildnis.modules.config.project_dependency)
R
readBuildCfgs() (Config method)
readConfigsJSON() (Config method)
readJSON() (in module buildnis.modules.helpers.json)
(JSONBaseClass method)
,
[1]
readSingleTarget() (Config static method)
regex (RunRegex attribute)
,
[1]
replaceConstants() (in module buildnis.modules.helpers.placeholder_regex)
replaceDateTimeConstants() (in module buildnis.modules.helpers.placeholder_regex)
replaceHostConstants() (in module buildnis.modules.helpers.placeholder_regex)
replaceProjectConstants() (in module buildnis.modules.helpers.placeholder_regex)
reReadIfChangedOnDisk() (JSONBaseClass method)
,
[1]
retryCPUInfo() (Host method)
returnExistingFile() (in module buildnis.modules.helpers.files)
reWriteIfChangedOnDisk() (JSONBaseClass method)
,
[1]
runCommand() (in module buildnis.modules.helpers.execute)
RunRegex (class in buildnis.modules.helpers.execute)
runScript() (Check method)
runScriptsInDir() (Check method)
S
script (EnvArgs attribute)
,
[1]
searchBuildTool() (Check method)
searchBuildTools() (Config method)
searchInStage() (Config method)
setAttrIfNotExist() (in module buildnis.modules.config.json_base_class)
setBuildToolCfgPath() (Config method)
setCleanStages() (CommandlineArguments method)
setConfigs() (CommandlineArguments method)
setConstants() (Host method)
setEnv() (in module buildnis.modules.helpers.execute)
setFileCompare() (in module buildnis.modules.helpers.json)
setHostConfigPath() (Config method)
setMustHaveAttribs() (ProjectDependency static method)
setOrigFile() (in module buildnis.modules.helpers.json)
setProjDepCfgPath() (Config method)
setProjectConstants() (Config method)
setStages() (CommandlineArguments method)
setupLogger() (in module buildnis.modules.helpers.commandline_arguments)
setupProjectCfg() (in module buildnis.modules.config.configure_build)
size (FileCompare attribute)
std_out (CmdOutput attribute)
,
[1]
W
WebException
website_url (ProjectDependency attribute)
writeBuildTools() (in module buildnis.modules.config.configure_build)
writeHostCfg() (in module buildnis.modules.config.configure_build)
writeJSON() (BuildCfg method)
,
[1]
(Config method)
(ConfigDirJson method)
,
[1]
(in module buildnis.modules.helpers.json)
(JSONBaseClass method)
,
[1]
(ModuleCfg method)
,
[1]
(ProjectDependency method)
writeProjectJSON() (in module buildnis.modules.config.configure_build)