makeprojects Namespace Reference

Root namespace for the makeprojects tool. More...

Namespaces
namespace	__main__
	Module that contains the code for the command line "makeprojects".
namespace	build_objects
	Module contains build objects for makeproject.
namespace	buildme
	Module that contains the code for the command line buildme.
namespace	cleanme
	Remove all temporary files in a project's folder.
namespace	codeblocks
	Sub file for makeprojects.
namespace	codewarrior
	Sub file for makeprojects.
namespace	config
	Package that reads, parses and processes the configuration file.
namespace	defaults
	Module that contains the code to generate defaults.
namespace	doxygen
	Module handles doxygen.
namespace	enums
	Enumeration types for makeprojects.
namespace	glsl_support
	Data and code to support GLSL targets.
namespace	hlsl_support
	Data and code to support HLSL targets.
namespace	makefile
	Sub file for makeprojects.
namespace	masm_support
	Data and code to support MASM targets.
namespace	modules
	Module that enumerates all of the builder modules.
namespace	ninja
	Sub file for makeprojects.
namespace	python
	Module the handles python script execution.
namespace	rebuildme
	Rebuild a project.
namespace	rezfile
	Module handles Rezfile.
namespace	slicer
	Module that handles slicer script files.
namespace	util
	The util module contains subroutines used everywhere.
namespace	validators
	Validation objects for project data generators.
namespace	visual_studio
	Project file generator for Microsoft Visual Studio 2003-2008.
namespace	visual_studio_2010
	Project file generator for Microsoft Visual Studio.
namespace	visual_studio_utils
	Project file generator subroutines for Microsoft Visual Studio 2003-2008.
namespace	watcom
	This module contains classes needed to generate project files intended for use by Open Watcom WMAKE 1.9 or higher.
namespace	watcom_util
	Project file generator subroutines for Open Watcom 1.9.
namespace	xcode
	Sub file for makeprojects.
namespace	xcode_utils
	Sub file for makeprojects.

Functions
	build (working_directory=None, args=None)
	Invoke the buildme command line from within Python.
	clean (working_directory=None, args=None)
	Invoke the cleanme command line from within Python.
	rebuild (working_directory=None, args=None)
	Invoke the rebuildme command line from within Python.
	makeprojects (working_directory=None, args=None)
	Invoke the makeprojects command line from within Python.
	new_configuration (configuration_list)
	Create a new instance of a core.Configuration.
	new_solution (name=None, platform=None, project_type=None)
	Create a new instance of a full solution.

Variables
tuple	__numversion__ = (1, 1, 1)
	Current version of the library as a numeric tuple.
str	__version__ = ".".join([str(num) for num in __numversion__])
	Current version of the library.
str	__author__ = "Rebecca Ann Heineman <becky@burgerbecky.com>"
	Author's name.
str	__title__ = "makeprojects"
	Name of the module.
str	__summary__ = "IDE project generator for Visual Studio, XCode, etc..."
	Summary of the module's use.
str	__uri__ = "http://makeprojects.readthedocs.io"
	Home page.
str	__email__ = "becky@burgerbecky.com"
	Email address for bug reports.
str	__license__ = "MIT License"
	Type of license used for distribution.
str	__copyright__ = "Copyright 2013-2025 Rebecca Ann Heineman"
	Copyright owner.
list	__all__
	Items to import on "from makeprojects import *".

Detailed Description

Root namespace for the makeprojects tool.

Makeprojects is a set of functions to generate project files for the most popular IDEs and build systems. Included are tools to automate building, cleaning and rebuilding projects.

Function Documentation

build()

makeprojects.build	(		working_directory = None,
			args = None )

Invoke the buildme command line from within Python.

Parameters

working_directory	None for current working directory.
args	Argument list to pass to the command, None uses sys.argv.

Returns

Zero on success, system error code on failure

See also

makeprojects.buildme

clean()

makeprojects.clean	(		working_directory = None,
			args = None )

Invoke the cleanme command line from within Python.

Parameters

working_directory	None for current working directory.
args	Argument list to pass to the command, None uses sys.argv

Returns

Zero on success, system error code on failure

See also

makeprojects.cleanme

makeprojects()

makeprojects.makeprojects	(		working_directory = None,
			args = None )

Invoke the makeprojects command line from within Python.

Parameters

working_directory	None for current working directory.
args	Argument list to pass to the command, None uses sys.argv

Returns

Zero on success, system error code on failure

See also

makeprojects.buildme

new_configuration()

makeprojects.new_configuration

(

configuration_list

)

Create a new instance of a core.Configuration.

Convenience routine to create a core.Configuration instance.

Parameters

configuration_list

Array of dict() records to describe configurations

Returns

None, a single Configuration or a list of valid Configuration records.

See also

core.Configuration

new_solution()

makeprojects.new_solution	(		name = None,
			platform = None,
			project_type = None )

Create a new instance of a full solution.

Convenience routine to create a Solution with a Project and three configurations "Debug", "Release", "Internal"

Parameters

name	Name of the project
platform	Platform for the project
project_type	Type of project

Returns

None, a fully stocked Solution

See also

core.Solution

rebuild()

makeprojects.rebuild	(		working_directory = None,
			args = None )

Invoke the rebuildme command line from within Python.

Parameters

working_directory	Directory to rebuild
args	Command line to use instead of sys.argv

Returns

Zero on no error, non-zero on error

See also

makeprojects.rebuildme

makeprojects.rebuildme.main

Variable Documentation

__all__

list makeprojects.__all__

private

Initial value:

=  [
    "build",
    "clean",
    "rebuild",
    "makeprojects",
    "new_solution",
 
    "FileTypes",
    "ProjectTypes",
    "IDETypes",
    "PlatformTypes",
    "add_burgerlib",
 
    "SourceFile",
    "Configuration",
    "Project",
    "Solution"
]

Items to import on "from makeprojects import *".