Burger for Python¶
The burger
module is a set of simple subroutines used by the Burgerlib
build system.
Documentation is found at https://pyburger.readthedocs.io
Doxygen generated documentation is found at https://pyburger.readthedocs.io/en/latest/doxygen
Python Packing Index (PyPI): https://pypi.python.org/pypi/burger
Source code and issue tracker: https://github.com/burgerbecky/pyburger
Compatibility¶
Python 2.7.1 or higher
Python 3.4 or higher
Installation¶
Type in pip install -U burger
. Some platforms may require the sudo
prefix.
Bugs¶
If you find a bug, issue or have a feature request, please submit a bug report by emailing becky@burgerbecky.com and mention python version, integer size (32 bit or 64 bit) and what platform was used (Windows / Mac OSX / Linux).
Table of Contents¶
- Constants
- Classes
- Functions
- String Functions
- strutils.unicode_print
- strutils.is_string
- strutils.convert_to_array
- strutils.string_to_bool
- strutils.TrueFalse
- strutils.truefalse
- strutils.TRUEFALSE
- strutils.convert_to_windows_slashes
- strutils.convert_to_linux_slashes
- strutils.encapsulate_path_windows
- strutils.encapsulate_path_linux
- strutils.encapsulate_path
- strutils.encapsulate_hosted_path
- strutils.split_comma_with_quotes
- strutils.parse_csv
- strutils.translate_to_regex_match
- strutils.host_machine
- strutils.get_windows_host_type
- strutils.get_mac_host_type
- strutils.escape_xml_cdata
- strutils.escape_xml_attribute
- strutils.packed_paths
- strutils.make_version_tuple
- File Locators
- buildutils.get_sdks_folder
- buildutils.find_in_path
- buildutils.where_is_doxygen
- buildutils.where_is_git
- buildutils.is_under_git_control
- buildutils.where_is_p4
- buildutils.is_under_p4_control
- buildutils.where_is_watcom
- buildutils.where_is_visual_studio
- buildutils.where_is_codeblocks
- buildutils.where_is_xcode
- File Functions
- fileutils.is_write_protected
- fileutils.make_executable
- fileutils.create_folder_if_needed
- fileutils.delete_file
- fileutils.is_source_newer
- fileutils.copy_file_if_needed
- fileutils.copy_directory_if_needed
- fileutils.shutil_readonly_cb
- fileutils.delete_directory
- fileutils.clean_directories
- fileutils.clean_files
- fileutils.get_tool_path
- fileutils.traverse_directory
- fileutils.unlock_files
- fileutils.lock_files
- fileutils.load_text_file
- fileutils.save_text_file
- fileutils.compare_files
- fileutils.compare_file_to_string
- fileutils.read_zero_terminated_string
- fileutils.save_text_file_if_newer
- Build Helpers
- buildutils.fix_csharp
- buildutils.is_exe
- buildutils.get_path_ext
- buildutils.make_exe_path
- buildutils.expand_and_verify
- buildutils.make_git_version_header
- buildutils.perforce_command
- buildutils.perforce_edit
- buildutils.perforce_add
- buildutils.perforce_opened
- buildutils.run_command
- buildutils.make_version_header
- buildutils.is_codewarrior_mac_allowed
- buildutils.import_py_script
- buildutils.run_py_script
- Clean Helpers
- Windows Functions
- String Functions
- True or False
- WSL, Cygwin, MSYS support
- Searching for Visual Studio
- Data type validators
- License