Build Targets - DLR-SC/DataFinder GitHub Wiki
To call a specific build target switch to project root directory and call the build script setup.py as shown here:
python setup.py [-GLOBAL OPTIONS] <BUILD TARGET NAME> [-BUILD TARGET OPTIONS]
Build target specific and global options can also be changed in the according configuration file setup.cfg. The file is structured as follows:
[global]
<OPTION1>=<OPTIONVALUE1>
<OPTION2>=<OPTIONVALUE2>
[<BUILD_TARGET>]
<OPTION1>=<OPTIONVALUE1>
<OPTION2>=<OPTIONVALUE2>
The required build tools are listed here.
The following table shows the available build targets. Paths to command line tools should be directly changed in setup.cfg. Results are put below the temporary created build directory.
| Build Target | Description | Relevant Options | Sub Targets | Required Tools |
|---|---|---|---|---|
| clean | Removes created temporary files (e.g., reports, generated source code, etc.) | - | - | - |
| gen | Generates Qt3 and Qt4 specific GUI and configuration modules. | - | _prepare, _gen_configuration_modules, _gen_qt3gui_modules, _gen_qt4gui_modules | generateDS, pyuic, pyuic4, pyrcc4 |
| test | Runs the unit tests and can create a coverage report. | `outputformat=[xml | coverage]: xmlcreates a XML report which is used for the Hudson CI builds.coveragecreates a code coverage report. Default: No option, results are printed on command line and no coverage report is created. coverageoutputformat=[html |
xml]: Only used if outputformat=coverage. htmlcreates a HTML coverage report.xmlcreate acoverage.xml` file in the project directory. |
| audit | Check coding style using pylint and creates a coverage report. | `outputformat=html | parseable: htmlcreates pylint and coverage reports in HTML format.parseablecreates pylint report in a parseable text file format and coverage report in XML format. This option is basically used in Hudson CI builds. Default:html` |
_prepare, _pylint, test |
| doc | Creates the developer documentation. | - | _prepare | epydoc |
| sdist | Creates a source distribution which includes the generated source code, script examples, and epydoc documentation of the script API. Use the global option --excludeClients to create a script source distribution without GUI. |
- | gen, doc | generateDS, pyuic, pyuic4, pyrcc4, epydoc |
| bdist | Creates a binary distribution including script examples and epydoc documentation of the script API. Also a separated python interpreter for script development is included. |
outputformat=[tar|nsis] tar creates compressed tar archives for the user client, the administration client, and both clients. nsis creates NSIS installers (win32 only) for the user client, the administrative client, and both clients. |
gen, doc | generateDS, pyuic, pyuic4, pyrcc4, epydoc, nsis |
| package_script_extension | Packages script extensions as tar archives. The root directory is script_extensions. For further details see: /script_extensions/README.txt
|
- | _prepare | - |