.. _f-setuphelper: module ``pycode.setup_helper`` ============================== Short summary +++++++++++++ module ``pyquickhelper.pycode.setup_helper`` Helper for the setup :githublink:`%|py|5` Functions +++++++++ +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +=============================================================================================================================+==================================================================================================================================+ | :func:`_get_dump_default_path ` | Proposes a default location to dump results about unit tests execution. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`available_commands_list ` | Checks that on command handled by pyquickhelper is part of the arguments. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`build_history_from_setup ` | Builds the history from :epkg:`github` and :epkg:`pypi`. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`clean_notebooks_for_numbers ` | Upgrades notebooks to the latest format and cleans notebooks execution numbers and rearranges the JSON file. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`clean_space_for_setup ` | | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`copy27_for_setup ` | Prepares a copy of the source for :epkg:`Python` 2.7, assuming the module follows the same design as *pyquickhelper*. ... | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_available_build_commands ` | Returns commands which build the package. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_available_setup_commands ` | Returns the list of commands :epkg:`pyquickhelper` implements or allows. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_folder ` | Returns the folder which contains ``setup.py``. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_script_extension ` | Returns the scripts extension based on the system it is running on. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`hash_list ` | Proposes a hash for the list of arguments. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`modifies_init_file ` | Automatically modifies the init file. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`process_argv_for_unittest ` | Interprets command line arguments. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`process_standard_options_for_setup ` | Processes the standard options the module pyquickhelper is able to process assuming the module which calls this function ... | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`process_standard_options_for_setup_help ` | Prints the added options available through this module. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`run_pylint_for_setup ` | Applies :epkg:`pylint` on subfolder *folder*. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`run_unittests_for_setup ` | Runs the unit tests and computes the coverage, stores the results in ``_doc/sphinxdoc/source/coverage`` assuming ... | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`standard_help_for_setup ` | Standard function which generates help assuming they follow the same design as *pyquickhelper*. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`write_module_scripts ` | Writes a couple of scripts which allow a user to be faster on some tasks or to easily get information about the module. ... | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`write_pyproj ` | Creates a project `pyproj `_ ... | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :func:`write_version_for_setup ` | Extracts the version number, the function writes the files ``version.txt`` in this folder. | +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.pycode.setup_helper :members: :special-members: __init__ :show-inheritance: