tools::project_api Namespace Reference

Generates a project file and creates a zip archive if specified

Positional Arguments:
src_paths - a list of paths from which to find source files
export_path - a path specifying the location of generated project files
target - the mbed board/mcu for which to generate the executable
ide - the ide for which to generate the project fields

Keyword Arguments:
libraries_paths - paths to additional libraries
options - build options passed by -o flag
linker_script - path to the linker script for the specified target
clean - removes the export_path if it exists
notify - function is passed all events, and expected to handle notification
  of the user, emit the events to a log, etc.
verbose - assigns the notify function to toolchains print_notify_verbose
name - project name
inc_dirs - additional include directories
jobs - number of threads
silent - silent build - no output
extra_verbose - assigns the notify function to toolchains
  print_notify_verbose
config - toolchain's config object
macros - User-defined macros
zip_proj - string name of the zip archive you wish to creat (exclude arg
 if you do not wish to create an archive

Generate the project files for a project

Positional arguments:
resources - a Resources object containing all of the files needed to build
  this project
export_path - location to place project files
name - name of the project
toolchain - a toolchain class that corresponds to the toolchain used by the
  IDE or makefile
ide - IDE name to export to

Optional arguments:
macros - additional macros that should be defined within the exported
  project

Return the exporter class and the toolchain string as a tuple

Positional arguments:
ide - the ide name of an exporter

Print out the results of an export process

Positional arguments:
successes - The list of exports that succeeded
failures - The list of exports that failed

Keyword arguments:
skips - The list of exports that were skipped

Replace the basepath of filename with export_path

Positional arguments:
file_name - the absolute path to a file
resources - the resources object that the file came from
export_path - the final destination of the file after export

Rewrite all of the basepaths with the export_path

Positional arguments:
resources - the resource object to rewrite the basepaths of
export_path - the final destination of the resources with respect to the
  generated project files

Create a zip file from an exported project.

Positional Parameters:
file_name - the file name of the resulting zip file
prefix - a directory name that will prefix the entire zip file's contents
resources - a resources object with files that must be included in the zip
project_files - a list of extra files to be added to the root of the prefix
  directory