.. _f-buildhelper:

module ``pycode.build_helper``
==============================







Short summary
+++++++++++++

module ``pyquickhelper.pycode.build_helper``

Produces a build file for a module following *pyquickhelper* design.


:githublink:`%|py|5`






Functions
+++++++++

+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| function                                                                                            | truncated documentation                                                                               |
+=====================================================================================================+=======================================================================================================+
| :func:`choose_path <pyquickhelper.pycode.build_helper.choose_path>`                                 | Returns the first path which exists in the list.                                                      |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :func:`get_build_script <pyquickhelper.pycode.build_helper.get_build_script>`                       | Builds the build script which builds the setup, run the unit tests and the documentation.             |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :func:`get_extra_script_command <pyquickhelper.pycode.build_helper.get_extra_script_command>`       | Produces a script which runs the notebook, a documentation server, which publishes...                 |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :func:`get_pyproj_project <pyquickhelper.pycode.build_helper.get_pyproj_project>`                   | returns a string which corresponds to a pyproj project                                                |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :func:`get_script_command <pyquickhelper.pycode.build_helper.get_script_command>`                   | Produces a script which runs a command available through the setup.                                   |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :func:`get_script_module <pyquickhelper.pycode.build_helper.get_script_module>`                     | Produces a script which runs the notebook, a documentation server, which publishes and other scripts. |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :func:`private_path_choice <pyquickhelper.pycode.build_helper.private_path_choice>`                 | Custom logic to reference other currently developped modules.                                         |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :func:`private_replacement_ <pyquickhelper.pycode.build_helper.private_replacement_>`               | Less copy/paste.                                                                                      |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :func:`private_script_replacements <pyquickhelper.pycode.build_helper.private_script_replacements>` | Runs last replacements.                                                                               |
+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pyquickhelper.pycode.build_helper
    :members:
    :special-members: __init__
    :show-inheritance: